From ac85fdd3505c0b2c7cc6f85ae659472fa787555c Mon Sep 17 00:00:00 2001 From: Slava Zanko Date: Mon, 27 Sep 2010 11:02:32 +0300 Subject: [PATCH] Minor changes: added doxy-comments for functions: - is_supported_encoding(); - panel_new(); - panel_new_with_dir(); - panel_change_encoding(). Signed-off-by: Slava Zanko --- src/charsets.c | 5 ++++- src/screen.c | 19 +++++++++++++------ 2 files changed, 17 insertions(+), 7 deletions(-) diff --git a/src/charsets.c b/src/charsets.c index 1638dc459..8b3e8d5a3 100644 --- a/src/charsets.c +++ b/src/charsets.c @@ -162,7 +162,10 @@ get_codepage_index (const char *id) return -1; } -/* return if encoding can by used in mc */ +/** Check if specified encoding can be used in mc. + * @param encoding name of encoding + * @returns TRUE if encoding has supported by mc, FALSE otherwise + */ gboolean is_supported_encoding (const char *encoding) { diff --git a/src/screen.c b/src/screen.c index ffc66f372..50f287aa0 100644 --- a/src/screen.c +++ b/src/screen.c @@ -1307,18 +1307,21 @@ panel_format_modified (WPanel * panel) panel->format_modified = 1; } -/* Panel creation */ -/* The parameter specifies the name of the panel for setup retieving */ +/** Panel creation. + * @param panel_name the name of the panel for setup retieving + * @returns new instance of WPanel + */ WPanel * panel_new (const char *panel_name) { return panel_new_with_dir (panel_name, NULL); } -/* Panel creation for specified directory */ -/* The parameter specifies the name of the panel for setup retieving */ -/* and the path of working panel directory. If path is NULL then */ -/* panel will be created for current directory */ +/** Panel creation for specified directory. + * @param panel_name the name of the panel for setup retieving + * @param the path of working panel directory. If path is NULL then panel will be created for current directory + * @returns new instance of WPanel + */ WPanel * panel_new_with_dir (const char *panel_name, const char *wpath) { @@ -3510,6 +3513,10 @@ panel_set_sort_order (WPanel * panel, const panel_field_t * sort_order) panel_re_sort (panel); } +/** + * Change panel encoding. + * @param panel WPanel object + */ void panel_change_encoding (WPanel * panel) {