[Cogl] [PATCH 36/53] doc: Expose CoglDepthState

[Damien Lespiau]

From: Damien Lespiau <damien.lespiau at intel.com>

It wasn't included to the documention up to now.
---
 cogl/cogl-depth-state.h                |   14 +++++++++-----
 doc/reference/cogl2/cogl2-docs.xml.in  |    1 +
 doc/reference/cogl2/cogl2-sections.txt |    5 +++--
 3 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/cogl/cogl-depth-state.h b/cogl/cogl-depth-state.h
index f9ecded..dadc2eb 100644
--- a/cogl/cogl-depth-state.h
+++ b/cogl/cogl-depth-state.h
@@ -39,8 +39,13 @@ COGL_BEGIN_DECLS
  *                     state of your GPU.
  */
 
-typedef struct
-{
+/**
+ * CoglDepthState
+ *
+ * Since: 2.0
+ */
+typedef struct {
+  /*< private >*/
   uint32_t COGL_PRIVATE (magic);
 
   CoglBool COGL_PRIVATE (test_enabled);
@@ -59,7 +64,6 @@ typedef struct
   uint32_t COGL_PRIVATE (padding7);
   uint32_t COGL_PRIVATE (padding8);
   uint32_t COGL_PRIVATE (padding9);
-
 } CoglDepthState;
 
 /**
@@ -91,7 +95,7 @@ cogl_depth_state_init (CoglDepthState *state);
  * value stored in the current depth buffer, and if the test passes
  * then the fragments depth value is used to update the depth buffer.
  * (unless you have disabled depth writing via
- * cogl_pipeline_set_depth_writing_enabled ())
+ * cogl_pipeline_set_depth_write_enabled())
  *
  * By default depth testing is disabled.
  *
@@ -149,7 +153,7 @@ cogl_depth_state_set_write_enabled (CoglDepthState *state,
  * @state: A #CoglDepthState struct
  *
  * Gets the depth writing enable state as set by the corresponding
- * cogl_pipeline_set_depth_writing_enabled.
+ * cogl_pipeline_set_depth_write_enabled().
  *
  * Returns: The current depth writing enable state
  * Since: 2.0
diff --git a/doc/reference/cogl2/cogl2-docs.xml.in b/doc/reference/cogl2/cogl2-docs.xml.in
index 251e558..06bc0ec 100644
--- a/doc/reference/cogl2/cogl2-docs.xml.in
+++ b/doc/reference/cogl2/cogl2-docs.xml.in
@@ -80,6 +80,7 @@
       <title>Setting Up A GPU Pipeline</title>
       <xi:include href="blend-strings.xml"/>
       <xi:include href="xml/cogl-pipeline.xml"/>
+      <xi:include href="xml/cogl-depth-state.xml"/>
       <xi:include href="xml/cogl-snippet.xml"/>
     </section>
 
diff --git a/doc/reference/cogl2/cogl2-sections.txt b/doc/reference/cogl2/cogl2-sections.txt
index 9440b95..1970f12 100644
--- a/doc/reference/cogl2/cogl2-sections.txt
+++ b/doc/reference/cogl2/cogl2-sections.txt
@@ -704,14 +704,15 @@ cogl_blend_string_error_domain
 
 <SECTION>
 <FILE>cogl-depth-state</FILE>
+<TITLE>Depth State</TITLE>
 CoglDepthState
 cogl_depth_state_init
 cogl_depth_state_set_test_enabled
 cogl_depth_state_get_test_enabled
 cogl_depth_state_set_test_function
 cogl_depth_state_get_test_function
-cogl_depth_state_set_writing_enabled
-cogl_depth_state_get_writing_enabled
+cogl_depth_state_set_write_enabled
+cogl_depth_state_get_write_enabled
 cogl_depth_state_set_range
 cogl_depth_state_get_range
 </SECTION>
-- 
1.7.7.5