summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelipe Erias Morandeira <femorandeira@igalia.com>2013-05-31 18:08:13 +0200
committerFelipe Erias Morandeira <femorandeira@igalia.com>2013-06-03 12:19:03 +0200
commit12399c46703eb7a7a435ae4d80856ce18f6fd105 (patch)
treea3400d95fb578e1f2b9241a7b4622158bffd24ce
parentfe0ceec09b893a617e3b1cfd99e4cc6c3454844f (diff)
Include eosenums.h in the documentation.
[endlessm/eos-sdk#30]
-rw-r--r--docs/reference/endless/Makefile.am2
-rw-r--r--docs/reference/endless/endless-docs.xml1
-rw-r--r--docs/reference/endless/endless-sections.txt5
-rw-r--r--endless/eosenums.h12
4 files changed, 16 insertions, 4 deletions
diff --git a/docs/reference/endless/Makefile.am b/docs/reference/endless/Makefile.am
index a90030d..da09231 100644
--- a/docs/reference/endless/Makefile.am
+++ b/docs/reference/endless/Makefile.am
@@ -49,7 +49,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= eosinit-private.h eostopbar-private.h eosmainarea-private.h
+IGNORE_HFILES= eosinit-private.h eostopbar-private.h eosmainarea-private.h eosactionbutton-private.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/docs/reference/endless/endless-docs.xml b/docs/reference/endless/endless-docs.xml
index 38d4ae3..0ae881f 100644
--- a/docs/reference/endless/endless-docs.xml
+++ b/docs/reference/endless/endless-docs.xml
@@ -20,6 +20,7 @@
<xi:include href="xml/application.xml"/>
<xi:include href="xml/window.xml"/>
<xi:include href="xml/page-manager.xml"/>
+ <xi:include href="xml/enums.xml"/>
<!--<xi:include href="xml/hello.xml"/>-->
</chapter>
diff --git a/docs/reference/endless/endless-sections.txt b/docs/reference/endless/endless-sections.txt
index fdb4b04..6b40e61 100644
--- a/docs/reference/endless/endless-sections.txt
+++ b/docs/reference/endless/endless-sections.txt
@@ -77,3 +77,8 @@ eos_page_manager_transition_type_get_type
<SUBSECTION Private>
EosPageManagerPrivate
</SECTION>
+
+<SECTION>
+<FILE>enums</FILE>
+EosActionButtonSize
+</SECTION>
diff --git a/endless/eosenums.h b/endless/eosenums.h
index 88df444..873213d 100644
--- a/endless/eosenums.h
+++ b/endless/eosenums.h
@@ -10,17 +10,23 @@
/* Shared typedefs for enumerations */
/**
- * SECTION:eosenum
+ * SECTION:enums
* @Short_description: Public enumerated types used throughout the Endless SDK
* @Title: Standard Enumerations
+ *
+ * Public enumerated types used throughout the Endless SDK.
*/
/**
* EosActionButtonSize:
+ * @EOS_ACTION_BUTTON_SIZE_PRIMARY: size for primary buttons
+ * @EOS_ACTION_BUTTON_SIZE_SECONDARY: size for secondary buttons
+ * @EOS_ACTION_BUTTON_SIZE_TERTIARY: size for tertiary buttons
+ * @EOS_ACTION_BUTTON_SIZE_QUATERNARY: size for quaternary buttons
+ * @EOS_ACTION_BUTTON_SIZE_NUM_SIZES: total number of sizes
*
- * Built-in sizes for @EosActionButton
+ * Built-in sizes for internal action buttons.
*/
-
typedef enum
{
EOS_ACTION_BUTTON_SIZE_PRIMARY = 0,