[devhelp] DhLanguage: make it private



commit 9670b3a92bd93bdbd715a6fc1174d929764846a5
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed May 3 18:18:51 2017 +0200

    DhLanguage: make it private
    
    It is used only by dh-book-manager.c. DhBookManager doesn't expose
    publicly DhLanguage, it is used internally to count the number of books
    in each programming language.
    
    The gtk-doc comments are removed, because it is not really useful, and
    in other classes the gtk-doc comments contained several errors, so it's
    better to have no comments at all than erroneous comments.

 docs/reference/Makefile.am          |    1 +
 docs/reference/devhelp-docs.xml     |    1 -
 docs/reference/devhelp-sections.txt |   21 ------------
 src/Makefile.am                     |    4 +-
 src/dh-language.c                   |   58 -----------------------------------
 5 files changed, 3 insertions(+), 82 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 8c28221..f5c0610 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -50,6 +50,7 @@ IGNORE_HFILES = \
        dh-assistant.h \
        dh-enum-types-app.h \
        dh-error.h \
+       dh-language.h \
        dh-parser.h \
        dh-preferences.h \
        dh-resources.h \
diff --git a/docs/reference/devhelp-docs.xml b/docs/reference/devhelp-docs.xml
index 0a0fede..5a7dade 100644
--- a/docs/reference/devhelp-docs.xml
+++ b/docs/reference/devhelp-docs.xml
@@ -24,7 +24,6 @@
     <xi:include href="xml/dh-book-manager.xml"/>
     <xi:include href="xml/dh-book-tree.xml"/>
     <xi:include href="xml/dh-keyword-model.xml"/>
-    <xi:include href="xml/dh-language.xml"/>
     <xi:include href="xml/dh-link.xml"/>
     <xi:include href="xml/dh-sidebar.xml"/>
   </chapter>
diff --git a/docs/reference/devhelp-sections.txt b/docs/reference/devhelp-sections.txt
index ab3e91a..9d7ea22 100644
--- a/docs/reference/devhelp-sections.txt
+++ b/docs/reference/devhelp-sections.txt
@@ -108,27 +108,6 @@ dh_keyword_model_get_type
 </SECTION>
 
 <SECTION>
-<FILE>dh-language</FILE>
-<TITLE>DhLanguage</TITLE>
-DhLanguage
-dh_language_new
-dh_language_get_name
-dh_language_compare
-dh_language_compare_by_name
-dh_language_get_n_books_enabled
-dh_language_inc_n_books_enabled
-dh_language_dec_n_books_enabled
-<SUBSECTION Standard>
-DH_IS_LANGUAGE
-DH_IS_LANGUAGE_CLASS
-DH_LANGUAGE
-DH_LANGUAGE_CLASS
-DH_LANGUAGE_GET_CLASS
-DH_TYPE_LANGUAGE
-dh_language_get_type
-</SECTION>
-
-<SECTION>
 <FILE>dh-link</FILE>
 <TITLE>DhLink</TITLE>
 DhLink
diff --git a/src/Makefile.am b/src/Makefile.am
index 29fcd09..45a6409 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -16,7 +16,6 @@ libdevhelp_public_headers =           \
        dh-book-manager.h               \
        dh-book-tree.h                  \
        dh-keyword-model.h              \
-       dh-language.h                   \
        dh-link.h                       \
        dh-sidebar.h                    \
        $(NULL)
@@ -28,13 +27,13 @@ libdevhelp_public_c_files =         \
        dh-book-tree.c                  \
        dh-common.c                     \
        dh-keyword-model.c              \
-       dh-language.c                   \
        dh-link.c                       \
        dh-sidebar.c                    \
        $(NULL)
 
 libdevhelp_private_headers =           \
        dh-error.h                      \
+       dh-language.h                   \
        dh-parser.h                     \
        dh-preferences.h                \
        dh-settings.h                   \
@@ -43,6 +42,7 @@ libdevhelp_private_headers =          \
 
 libdevhelp_private_c_files =           \
        dh-error.c                      \
+       dh-language.c                   \
        dh-parser.c                     \
        dh-preferences.c                \
        dh-util.c                       \
diff --git a/src/dh-language.c b/src/dh-language.c
index 3e3521b..f7cd289 100644
--- a/src/dh-language.c
+++ b/src/dh-language.c
@@ -53,14 +53,6 @@ dh_language_init (DhLanguage *language)
 {
 }
 
-/**
- * dh_language_new:
- * @name: the name of the language
- *
- * Create a new #DhLanguage object.
- *
- * Returns: a new #DhLanguage object
- */
 DhLanguage *
 dh_language_new (const gchar *name)
 {
@@ -77,16 +69,6 @@ dh_language_new (const gchar *name)
         return language;
 }
 
-/**
- * dh_language_compare:
- * @language_a: a #DhLanguage object
- * @language_b: the #DhLanguage object to compare with
- *
- * Compares the name of @language_a with the name @language_b.
- *
- * Returns: an integer less than, equal to, or greater than zero, if the name
- * of @language_a is <, == or > than the name of @language_b
- */
 gint
 dh_language_compare (DhLanguage *language_a,
                      DhLanguage *language_b)
@@ -98,16 +80,6 @@ dh_language_compare (DhLanguage *language_a,
                        dh_language_get_name (language_b));
 }
 
-/**
- * dh_language_compare_by_name:
- * @language_a: a #DhLanguage object
- * @language_name_b: the language name to compare with
- *
- * Compares the name of @language_a with @language_name_b.
- *
- * Returns: an integer less than, equal to, or greater than zero, if the name
- * of @language_a is <, == or > than @language_name_b
- */
 gint
 dh_language_compare_by_name (DhLanguage  *language_a,
                              const gchar *language_name_b)
@@ -119,14 +91,6 @@ dh_language_compare_by_name (DhLanguage  *language_a,
                        language_name_b);
 }
 
-/**
- * dh_language_get_name:
- * @language: a #DhLanguage object
- *
- * Get the language name.
- *
- * Returns: The name of the language
- */
 const gchar *
 dh_language_get_name (DhLanguage *language)
 {
@@ -138,14 +102,6 @@ dh_language_get_name (DhLanguage *language)
         return priv->name;
 }
 
-/**
- * dh_language_get_n_books_enabled:
- * @language: a #DhLanguage object
- *
- * Get the number of enabled books
- *
- * Returns: The number of enabled books
- */
 gint
 dh_language_get_n_books_enabled (DhLanguage *language)
 {
@@ -157,12 +113,6 @@ dh_language_get_n_books_enabled (DhLanguage *language)
         return priv->n_books_enabled;
 }
 
-/**
- * dh_language_inc_n_books_enabled:
- * @language: a #DhLanguage object
- *
- * Increase the number of enabled books for this language.
- */
 void
 dh_language_inc_n_books_enabled (DhLanguage *language)
 {
@@ -174,14 +124,6 @@ dh_language_inc_n_books_enabled (DhLanguage *language)
         priv->n_books_enabled++;
 }
 
-/**
- * dh_language_dec_n_books_enabled:
- * @language: a #DhLanguage object
- *
- * Decrease the number of enabled books for this language.
- *
- * Returns: %TRUE if the counter is decreased to zero, %FALSE otherwise.
- */
 gboolean
 dh_language_dec_n_books_enabled (DhLanguage *language)
 {


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