[beast] SFI: docu cleanups



commit 3c0707d016ff6b05e76fc71fbedecf2fa8290fea
Author: Tim Janik <timj gtk org>
Date:   Sun May 8 03:08:58 2011 +0200

    SFI: docu cleanups

 sfi/sfifilecrawler.c |   12 +++++-------
 sfi/sfitime.c        |   40 +++++++++++++++++++---------------------
 2 files changed, 24 insertions(+), 28 deletions(-)
---
diff --git a/sfi/sfifilecrawler.c b/sfi/sfifilecrawler.c
index 4d65e92..bf13061 100644
--- a/sfi/sfifilecrawler.c
+++ b/sfi/sfifilecrawler.c
@@ -573,13 +573,11 @@ sfi_path_get_filename (const gchar  *filename,
  * which allowes for more detailed mode tests and is recommended
  * over use of this function.
  * Here is the list of possible GFileTest flags:
- * @itemize
- * @item G_FILE_TEST_IS_REGULAR    - test for a recular file
- * @item G_FILE_TEST_IS_SYMLINK    - test for a symlink
- * @item G_FILE_TEST_IS_DIR        - test for a directory
- * @item G_FILE_TEST_IS_EXECUTABLE - test for an executable
- * @item G_FILE_TEST_EXISTS        - test whether the file exists
- * @done
+ * @li @c G_FILE_TEST_IS_REGULAR    - test for a recular file
+ * @li @c G_FILE_TEST_IS_SYMLINK    - test for a symlink
+ * @li @c G_FILE_TEST_IS_DIR        - test for a directory
+ * @li @c G_FILE_TEST_IS_EXECUTABLE - test for an executable
+ * @li @c G_FILE_TEST_EXISTS        - test whether the file exists
  */
 gboolean
 g_file_test_all (const gchar  *file,
diff --git a/sfi/sfitime.c b/sfi/sfitime.c
index 72be796..f87d4d6 100644
--- a/sfi/sfitime.c
+++ b/sfi/sfitime.c
@@ -159,27 +159,25 @@ sfi_time_to_string (SfiTime ustime)
 }
 
 /**
-   @param ustime	time in micro seconds
-   @param elements      string identifying time elements
-   @return		newly allocated string
-   
-   Retrieve the time @a ustime in human readable form.
-   Within the rnage of date and time formats parsable by
-   sfi_time_from_string(), the nicest display is selected
-   according to the current locale and other user settings.
-   By means of the @a elements argument, various elemtns of
-   a full date string can be selected:
-   @itemize
-   @item H - display hours
-   @item M - display minutes
-   @item S - display seconds
-   @item d - display day
-   @item m - display month
-   @item y - display year
-   @done
-   The returned time string describes UTC time and
-   thus contains no time zone or UTC offset information.
-*/
+ * @param ustime	time in micro seconds
+ * @param elements      string identifying time elements
+ * @return		newly allocated string
+ * Retrieve the time @a ustime in human readable form.
+ * Within the rnage of date and time formats parsable by
+ * sfi_time_from_string(), the nicest display is selected
+ * according to the current locale and other user settings.
+ * By means of the @a elements argument, various elemtns of
+ * a full date string can be selected:
+ * @li @c H - display hours
+ * @li @c M - display minutes
+ * @li @c S - display seconds
+ * @li @c d - display day
+ * @li @c m - display month
+ * @li @c y - display year
+ *
+ * The returned time string describes UTC time and
+ * thus contains no time zone or UTC offset information.
+ */
 gchar*
 sfi_time_to_nice_string (SfiTime      ustime,
                          const gchar *elements)



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]