[cogl/cogl-1.12] doc: Generate a valid cogl-context.xml



commit 70f71e26275a294e5b1c4bfd5426fae8f911aa06
Author: Damien Lespiau <damien lespiau intel com>
Date:   Sat Dec 29 20:12:13 2012 +0000

    doc: Generate a valid cogl-context.xml
    
    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?!
    
    (cherry picked from commit 606b472d91450e3221da6631020f534892e866a9)

 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 0c6f0b5..c44a08b 100644
--- a/cogl/cogl-context.h
+++ b/cogl/cogl-context.h
@@ -67,7 +67,7 @@ G_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 @@ G_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>
  */
 
 #ifdef COGL_ENABLE_EXPERIMENTAL_API



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]