[Xfce4-commits] [xfce/xfce4-panel] 03/04: Correctly deprecate XfceHVBox in documentation

[noreply at xfce.org]

This is an automated email from the git hooks/post-receive script.

o   c   h   o   s   i       p   u   s   h   e   d       a       c   o   m   m   i   t       t   o       b   r   a   n   c   h       m   a   s   t   e   r   
   in repository xfce/xfce4-panel.

commit 7a98414d468ac09d80b8e4ac894bc053790d0145
Author: Romain B <skunnyk at alteroot.org>
Date:   Mon Dec 11 13:33:03 2017 +0100

    Correctly deprecate XfceHVBox in documentation
    
    - Print deprecated warnings in generated gtkdoc
---
 docs/references/Makefile.am                |  5 +++--
 docs/references/libxfce4panel-docs.xml     |  1 +
 docs/references/libxfce4panel-sections.txt | 18 ++++++++++++++++++
 libxfce4panel/xfce-hvbox.c                 | 15 +++++++++++----
 4 files changed, 33 insertions(+), 6 deletions(-)

diff --git a/docs/references/Makefile.am b/docs/references/Makefile.am
index e760d3f..bae17c7 100644
--- a/docs/references/Makefile.am
+++ b/docs/references/Makefile.am
@@ -10,7 +10,7 @@ DOC_MODULE_VERSION=$(LIBXFCE4PANEL_VERSION_API)
 DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 
 # Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS=
+SCAN_OPTIONS=--deprecated-guards="LIBXFCE4PANEL_DEPRECATED"
 
 # The directory containing the source code. Relative to $(srcdir)
 DOC_SOURCE_DIR=../../libxfce4panel
@@ -29,7 +29,8 @@ CFILE_GLOB=$(top_srcdir)/libxfce4panel/*.c
 IGNORE_HFILES= \
 	libxfce4panel-alias.h \
 	libxfce4panel-marshal.h \
-	xfce-panel-plugin-provider.h
+	xfce-panel-plugin-provider.h \
+	libxfce4panel-enum-types.h
 
 # Extra files to add when scanning (relative to $srcdir)
 EXTRA_HFILES=
diff --git a/docs/references/libxfce4panel-docs.xml b/docs/references/libxfce4panel-docs.xml
index 3ebf750..e77fa33 100644
--- a/docs/references/libxfce4panel-docs.xml
+++ b/docs/references/libxfce4panel-docs.xml
@@ -151,6 +151,7 @@
     <para>This section describes the additional widgets provided by the <application>xfce4-panel</application> library.</para>
 
     <xi:include href="xml/xfce-arrow-button.xml"/>
+    <xi:include href="xml/xfce-hvbox.xml"/>
     <xi:include href="xml/xfce-panel-image.xml"/>
   </part>
 
diff --git a/docs/references/libxfce4panel-sections.txt b/docs/references/libxfce4panel-sections.txt
index 2bfc3fa..f58be39 100644
--- a/docs/references/libxfce4panel-sections.txt
+++ b/docs/references/libxfce4panel-sections.txt
@@ -34,6 +34,24 @@ xfce_arrow_button_get_type
 </SECTION>
 
 <SECTION>
+<FILE>xfce-hvbox</FILE>
+XfceHVBox
+xfce_hvbox_new
+xfce_hvbox_set_orientation
+xfce_hvbox_get_orientation
+<SUBSECTION Standard>
+XfceHVBoxClass
+XFCE_TYPE_HVBOX
+XFCE_HVBOX
+XFCE_HVBOX_CLASS
+XFCE_IS_HVBOX
+XFCE_IS_HVBOX_CLASS
+XFCE_HVBOX_GET_CLASS
+<SUBSECTION Private>
+xfce_hvbox_get_type
+</SECTION>
+
+<SECTION>
 <FILE>convenience</FILE>
 xfce_panel_create_button
 xfce_panel_create_toggle_button
diff --git a/libxfce4panel/xfce-hvbox.c b/libxfce4panel/xfce-hvbox.c
index 33f482b..9b25523 100644
--- a/libxfce4panel/xfce-hvbox.c
+++ b/libxfce4panel/xfce-hvbox.c
@@ -39,13 +39,14 @@
  * @short_description: Container widget with configurable orientation
  * @include: libxfce4panel/libxfce4panel.h
  *
+ * > #XfceHVBox is deprecated and will not work with Gtk3.
+ * > If your code depends on Gtk+ 2.16 or later, if it better to use
+ * > the normal #GtkBox widgets in combination with
+ * > gtk_orientable_set_orientation().
+ *
  * #XfceHVBox is a #GtkBox widget that allows the user to change
  * its orientation. It is in fact a combination of #GtkHBox and #GtkVBox.
  *
- * If your code depends on Gtk+ 2.16 or later, if it better to use
- * the normal #GtkBox widgets in combination with
- * gtk_orientable_set_orientation().
- *
  * See also: #GtkOrientable and #GtkBox.
  **/
 
@@ -227,6 +228,8 @@ xfce_hvbox_size_allocate (GtkWidget     *widget,
  *
  * Creates a new #XfceHVBox container widget.
  *
+ * Deprecated: 4.14: Use gtk_box_new() instead
+ *
  * Returns: the newly allocated #XfceHVBox container widget.
  **/
 GtkWidget *
@@ -258,6 +261,8 @@ xfce_hvbox_new (GtkOrientation orientation,
  * @orientation : the new orientation of the #XfceHVBox
  *
  * Set the new orientation of the #XfceHVBox container widget.
+ *
+ * Deprecated: 4.14: Use gtk_orientable_set_orientation() instead
  **/
 void
 xfce_hvbox_set_orientation (XfceHVBox      *hvbox,
@@ -286,6 +291,8 @@ xfce_hvbox_set_orientation (XfceHVBox      *hvbox,
  *
  * Get the current orientation of the @hvbox.
  *
+ * Deprecated: 4.14: Use gtk_orientable_get_orientation() instead
+ *
  * Returns: the current orientation of the #XfceHVBox.
  **/
 GtkOrientation

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.