[gom] sorting: Improve the gom_sorting_new documentation



commit ab60def8a5f270fd66e26b34abbf5394287e9425
Author: Mathieu Bridon <bochecha daitauha fr>
Date:   Thu Jul 9 16:17:26 2015 +0200

    sorting: Improve the gom_sorting_new documentation
    
    This adds language markup, and the proper # signs in front of types.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=752141

 gom/gom-sorting.c |   10 ++++++----
 1 files changed, 6 insertions(+), 4 deletions(-)
---
diff --git a/gom/gom-sorting.c b/gom/gom-sorting.c
index 0b339ad..a5a4a95 100644
--- a/gom/gom-sorting.c
+++ b/gom/gom-sorting.c
@@ -112,8 +112,8 @@ get_table (GType       type,
 /**
  * gom_sorting_new: (constructor)
  * @first_resource_type: A subclass of #GomResource.
- * @first_property_name: A pointer to a const gchar.
- * @first_sorting_mode: A GomSortingMode.
+ * @first_property_name: A string.
+ * @first_sorting_mode: A #GomSortingMode.
  * @...: Additional triples of resource_type/property_name/sorting_mode,
  *       followed by %NULL.
  *
@@ -123,17 +123,19 @@ get_table (GType       type,
  * the proper "ORDER BY" SQL statements.
  *
  * Example:
- *
+ * |[<!-- language="C" -->
  *     GomSorting *sorting = gom_sorting_new(EPISODE_TYPE_RESOURCE,
  *                                           "season-number",
  *                                           GOM_SORTING_DESCENDING,
  *                                           EPISODE_TYPE_RESOURCE,
  *                                           "episode-number",
  *                                           GOM_SORTING_ASCENDING);
+ * ]|
  *
  * The above example maps to the following SQL statement:
- *
+ * |[<!-- language="SQL" -->
  *     ORDER BY 'episodes'.'season-number' DESC, 'episodes'.'episode-number'
+ * ]|
  *
  * Returns: (transfer full): A #GomSorting.
  */


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