[gnome-panel/wip/segeiger/reference-documentation: 6/17] libpanel-applet: document undocumented macros

[Sebastian Geiger <segeiger src gnome org>]

commit 5021b80b557535ca616d8f4278cf3c6d8be7c67b
Author: Sebastian Geiger <sbastig gmx net>
Date:   Thu Aug 27 00:30:54 2015 +0200

    libpanel-applet: document undocumented macros

 .../panel-applet/panel-applet-sections.txt         |    3 ++
 libpanel-applet/panel-applet.h                     |   22 +++++++++++++++++++-
 2 files changed, 24 insertions(+), 1 deletions(-)
---
diff --git a/doc/reference/panel-applet/panel-applet-sections.txt 
b/doc/reference/panel-applet/panel-applet-sections.txt
index 2ac892f..48ecf01 100644
--- a/doc/reference/panel-applet/panel-applet-sections.txt
+++ b/doc/reference/panel-applet/panel-applet-sections.txt
@@ -5,7 +5,10 @@
 <TITLE>Panel Applet</TITLE>
 PanelApplet
 PanelAppletOrient
+PANEL_APPLET_ORIENT_FIRST
+PANEL_APPLET_ORIENT_LAST
 PanelAppletFlags
+PANEL_APPLET_FLAGS_ALL
 panel_applet_get_orient
 panel_applet_get_gtk_orientation
 panel_applet_set_size_hints
diff --git a/libpanel-applet/panel-applet.h b/libpanel-applet/panel-applet.h
index dd6066e..0672784 100644
--- a/libpanel-applet/panel-applet.h
+++ b/libpanel-applet/panel-applet.h
@@ -50,7 +50,18 @@ typedef enum {
        PANEL_APPLET_ORIENT_RIGHT
 } PanelAppletOrient;
 
+/**
+ * PANEL_APPLET_ORIENT_FIRST:
+ *
+ * This macro is an alias for #PANEL_APPLET_ORIENT_UP
+ **/
 #define PANEL_APPLET_ORIENT_FIRST PANEL_APPLET_ORIENT_UP
+
+/**
+ * PANEL_APPLET_ORIENT_LAST
+ *
+ * This macro is an alias for #PANEL_APPLET_ORIENT_RIGHT
+ **/
 #define PANEL_APPLET_ORIENT_LAST  PANEL_APPLET_ORIENT_RIGHT
 
 #define PANEL_TYPE_APPLET         (panel_applet_get_type ())
@@ -84,7 +95,16 @@ typedef enum {
        PANEL_APPLET_HAS_HANDLE   = 1 << 2
 } PanelAppletFlags;
 
-#define PANEL_APPLET_FLAGS_ALL (PANEL_APPLET_EXPAND_MAJOR|PANEL_APPLET_EXPAND_MINOR|PANEL_APPLET_HAS_HANDLE)
+/**
+ * PANEL_APPLET_FLAGS_ALL:
+ *
+ * A convenience macro that combines #PANEL_APPLET_EXPAND_MAJOR, #PANEL_APPLET_EXPAND_MINOR and
+ *     #PANEL_APPLET_HAS_HANDLE from #PanelAppletFlags
+ **/
+#define PANEL_APPLET_FLAGS_ALL \
+                               (PANEL_APPLET_EXPAND_MAJOR | \
+                                PANEL_APPLET_EXPAND_MINOR | \
+                                PANEL_APPLET_HAS_HANDLE)
 
 typedef struct _PanelApplet        PanelApplet;
 typedef struct _PanelAppletClass   PanelAppletClass;