[devhelp/wip/privatize-classes: 1/4] Assistant: first step to make it private



commit f2e3c1b27f77d89b8b9ac05b4f630b6323ee5e7f
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed May 3 12:27:36 2017 +0200

    Assistant: first step to make it private
    
    DhAssistantView is re-usable, but not DhAssistant. DhAssistant depends
    on DhApp, and DhApp is a subclass of GtkApplication. An application can
    have only one GtkApplication instance, so DhApp in the current state
    doesn't make sense as a library.
    
    This is the first step to make DhAssistant private, it removes the class
    from the public docs.
    
    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 |   17 -----------------
 src/dh-assistant.c                  |   17 -----------------
 4 files changed, 1 insertions(+), 35 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 9f8262e..0dd920f 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -45,6 +45,7 @@ EXTRA_HFILES =
 # Header files or dirs to ignore when scanning. Use base file/dir names
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
 IGNORE_HFILES = \
+       dh-assistant.h \
        dh-enum-types.h \
        dh-error.h \
        dh-parser.h \
diff --git a/docs/reference/devhelp-docs.xml b/docs/reference/devhelp-docs.xml
index 0a5966e..9504c55 100644
--- a/docs/reference/devhelp-docs.xml
+++ b/docs/reference/devhelp-docs.xml
@@ -20,7 +20,6 @@
     <title>API Reference</title>
     <xi:include href="xml/init.xml"/>
     <xi:include href="xml/dh-app.xml"/>
-    <xi:include href="xml/dh-assistant.xml"/>
     <xi:include href="xml/dh-assistant-view.xml"/>
     <xi:include href="xml/dh-book.xml"/>
     <xi:include href="xml/dh-book-manager.xml"/>
diff --git a/docs/reference/devhelp-sections.txt b/docs/reference/devhelp-sections.txt
index f150ad3..94a8772 100644
--- a/docs/reference/devhelp-sections.txt
+++ b/docs/reference/devhelp-sections.txt
@@ -28,23 +28,6 @@ dh_app_get_type
 </SECTION>
 
 <SECTION>
-<FILE>dh-assistant</FILE>
-<TITLE>DhAssistant</TITLE>
-DhAssistant
-dh_assistant_new
-dh_assistant_search
-<SUBSECTION Standard>
-DhAssistantClass
-DH_ASSISTANT
-DH_ASSISTANT_CLASS
-DH_ASSISTANT_GET_CLASS
-DH_IS_ASSISTANT
-DH_IS_ASSISTANT_CLASS
-DH_TYPE_ASSISTANT
-dh_assistant_get_type
-</SECTION>
-
-<SECTION>
 <FILE>dh-assistant-view</FILE>
 <TITLE>DhAssistantView</TITLE>
 DhAssistantView
diff --git a/src/dh-assistant.c b/src/dh-assistant.c
index 0accc04..f9a1a2c 100644
--- a/src/dh-assistant.c
+++ b/src/dh-assistant.c
@@ -103,14 +103,6 @@ dh_assistant_init (DhAssistant *assistant)
                                          FALSE);
 }
 
-/**
- * dh_assistant_new:
- * @application: the parent #DhApp
- *
- * Create a new #DhAssistant object.
- *
- * Returns: a new #DhAssistant object
- */
 GtkWidget *
 dh_assistant_new (DhApp *application)
 {
@@ -119,15 +111,6 @@ dh_assistant_new (DhApp *application)
                              NULL);
 }
 
-/**
- * dh_assistant_search:
- * @assistant: a #DhAssistant object
- * @str: the search query
- *
- * Search for @str in the current assistant.
- *
- * Returns: %TRUE if @str was found, %FALSE otherwise
- */
 gboolean
 dh_assistant_search (DhAssistant *assistant,
                      const gchar *str)


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