[gtk-doc] help: little clarification for line break handling.



commit 27460efb04d85ace594ecea1a9c5139574e877bd
Author: Stefan Sauer <ensonic users sf net>
Date:   Wed Jun 27 13:48:00 2012 +0200

    help: little clarification for line break handling.

 help/manual/C/gtk-doc-manual.xml |    3 ++-
 tests/gobject/src/gobject.c      |    4 +++-
 2 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/help/manual/C/gtk-doc-manual.xml b/help/manual/C/gtk-doc-manual.xml
index d707068..10b1ed1 100644
--- a/help/manual/C/gtk-doc-manual.xml
+++ b/help/manual/C/gtk-doc-manual.xml
@@ -746,7 +746,8 @@ gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html
         listings and CDATA sections) just containing a ' *' (blank-asterisk) are
         converted to paragraph breaks.
         If you don't want a paragraph break, change that into ' *  '
-        (blank-asterisk-blank-blank).
+        (blank-asterisk-blank-blank). This is useful in preformatted text (code
+        listings).
       </para>
 
       <tip>
diff --git a/tests/gobject/src/gobject.c b/tests/gobject/src/gobject.c
index fefe557..01fdd04 100644
--- a/tests/gobject/src/gobject.c
+++ b/tests/gobject/src/gobject.c
@@ -95,7 +95,9 @@ GtkdocObject *gtkdoc_object_new (void) {
  * @value: the new otest value, whose description extends further than one
  *  line will allow
  *
- * Set the #GtkdocObject:otest property.
+ * Set the #GtkdocObject:otest property. This is a long paragraph.
+ *
+ * Oh, btw. setting the property directly saves us one method.
  *
  * Deprecated: Use g_object_set(obj,&quot;otest&quot;,value,NULL); instead.
  *



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