[Cogl] [PATCH 03/53] doc: Generate a valid cogl-context.xml

Damien Lespiau damien.lespiau at gmail.com
Tue Jan 1 06:30:39 PST 2013


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

The automagic paragraph support of gtk-doc is way too simple to support
things like multi-paragraphs <note>s. Let's trick gtk-doc and make it
generate a valid docbook snippet for cogl-context.

Without this, cogl-context remains absent of the reference
documentation, how sad is this?!
---
 cogl/cogl-context.h |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/cogl/cogl-context.h b/cogl/cogl-context.h
index 587dff7..fd41867 100644
--- a/cogl/cogl-context.h
+++ b/cogl/cogl-context.h
@@ -67,7 +67,7 @@ COGL_BEGIN_DECLS
  * that can all access the same GPU without having to worry about
  * what state other components have left you with.
  *
- * <note>Cogl does not maintain internal references to the context for
+ * <note><para>Cogl does not maintain internal references to the context for
  * resources that depend on the context so applications. This is to
  * help applications control the lifetime a context without us needing to
  * introduce special api to handle the breakup of internal circular
@@ -84,7 +84,7 @@ COGL_BEGIN_DECLS
  * times throughout their lifetime (such as Android applications) they
  * should be careful to destroy all context dependant resources, such as
  * framebuffers or textures etc before unrefing and destroying the
- * context.<note>
+ * context.</para></note>
  */
 
 #define COGL_CONTEXT(OBJECT) ((CoglContext *)OBJECT)
-- 
1.7.7.5



More information about the Cogl mailing list