[gnome-commander] noop: comment update

[Uwe Scholz <uwescholz src gnome org>]

commit ed5f38fa7e3a9934f666df15a7b241607069b2c4
Author: Uwe Scholz <uwescholz src gnome org>
Date:   Sat Jan 31 22:50:06 2015 +0100

    noop: comment update

 src/gnome-cmd-file-list.h |   46 +++++++++++++++++++++++++++++++++++++-------
 1 files changed, 38 insertions(+), 8 deletions(-)
---
diff --git a/src/gnome-cmd-file-list.h b/src/gnome-cmd-file-list.h
index bb26564..6526a9e 100644
--- a/src/gnome-cmd-file-list.h
+++ b/src/gnome-cmd-file-list.h
@@ -148,14 +148,44 @@ struct GnomeCmdFileList
     void sort();
     GList *sort_selection(GList *list);
 
-    GList *get_visible_files();                 // Returns a list with all files shown in the file list. The 
list is the same as that in the file list it self so make a copy and ref the files if needed
-    GList *get_selected_files();                // Returns a list with all selected files. The list returned 
is a copy and should be freed when no longer needed. The files in the list is however not refed before 
returning
-    GnomeCmd::Collection<GnomeCmdFile *> &get_marked_files();  // Returns a collection of all selected files.
-                                                // A marked file is a file that has been selected with ins 
etc. The file that is currently focused is not marked
-
-    GnomeCmdFile *get_focused_file();           // Returns the currently focused file if any. The returned 
file is not reffed. The ".." file is returned if focused
-    GnomeCmdFile *get_selected_file();          // Returns the currently focused file if any. The returned 
file is not reffed. The ".." file is NOT returned if focused
-    GnomeCmdFile *get_first_selected_file();    // Returns the first selected file if any or the focused one 
otherwise. The returned file is not reffed. The ".." file is NOT returned if focused
+    /**
+     * Returns a list with all files shown in the file list. The list is
+     * the same as that in the file list it self so make a copy and ref
+     * the files if needed
+     */    
+    GList *get_visible_files();
+
+    /**
+     * Returns a list with all selected files. The list returned is a
+     * copy and should be freed when no longer needed. The files in the
+     * list is however not refed before returning
+     */
+    GList *get_selected_files();
+    
+    /**
+     * Returns a collection of all selected files.
+     * A marked file is a file that has been selected with ins etc. The file that is currently focused is 
not marked.
+     */
+    GnomeCmd::Collection<GnomeCmdFile *> &get_marked_files();
+                                              
+    /**
+     * Returns the currently focused file if any. The returned file is
+     * not reffed. The ".." file is returned if focused
+     */
+    GnomeCmdFile *get_focused_file();
+
+    /**
+     * Returns the currently focused file if any. The returned file is
+     * not reffed. The ".." file is NOT returned if focused
+     */
+    GnomeCmdFile *get_selected_file();
+
+    /**
+     * Returns the first selected file if any or the focused one
+     * otherwise. The returned file is not reffed. The ".." file is NOT
+     * returned if focused
+     */
+    GnomeCmdFile *get_first_selected_file();
 
     gboolean file_is_wanted(GnomeCmdFile *f);