gtk-doc r560 - in trunk: . help/manual/C tests/gobject/src

[stefkost svn gnome org]

Author: stefkost
Date: Mon May  5 10:41:47 2008
New Revision: 560
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=560&view=rev

Log:
	* TODO:
	  Make note about expanding urls.
	* help/manual/C/gtk-doc-manual.xml:
	  Document the use of |[ |] as a shortcut for program listing.
	* tests/gobject/src/giface.h:
	* tests/gobject/src/gobject.c:
	  Fix one undocumented symbol and add an exampl of the programlisting
	  shortcut.



Modified:
   trunk/ChangeLog
   trunk/TODO
   trunk/help/manual/C/gtk-doc-manual.xml
   trunk/tests/gobject/src/giface.h
   trunk/tests/gobject/src/gobject.c

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Mon May  5 10:41:47 2008
@@ -22,4 +22,7 @@
        [print __FILE__ . ":" . __LINE__ . ":" . ] or [#]
      should be a function and the function should support loglevels and an
        envar to enable/disable conditionally;
-       
+
+More abbreviations:
+* expand urls
+

Modified: trunk/help/manual/C/gtk-doc-manual.xml
==============================================================================
--- trunk/help/manual/C/gtk-doc-manual.xml	(original)
+++ trunk/help/manual/C/gtk-doc-manual.xml	Mon May  5 10:41:47 2008
@@ -41,7 +41,10 @@
         </affiliation>
       </author>
     </authorgroup>
-    <publisher role="maintainer"><address><email>gtk-doc-list gnome org</email></address></publisher>
+    <publisher role="maintainer">
+      <publishername>GTK-Doc project</publishername>
+      <address><email>gtk-doc-list gnome org</email></address>
+    </publisher>
     <copyright>
       <year>2000, 2005, 2007-2008</year>
       <holder>Dan Mueth and Chris Lyttle and Stefan Kost</holder>
@@ -976,6 +979,12 @@
 ]]>
           </programlisting>
         </informalexample>
+        For the latter gtk-doc also supports an abbreviation:
+<![CDATA[
+|[
+  ...
+]|
+]]>
       </para>
 
       <para>

Modified: trunk/tests/gobject/src/giface.h
==============================================================================
--- trunk/tests/gobject/src/giface.h	(original)
+++ trunk/tests/gobject/src/giface.h	Mon May  5 10:41:47 2008
@@ -11,6 +11,11 @@
 
 /* type macros */
 
+/**
+ * GtkdocIface:
+ *
+ * opaque instance of gtk-doc unit test interface
+ */
 typedef struct _GtkdocIface GtkdocIface;
 typedef struct _GtkdocIfaceInterface GtkdocIfaceInterface;
 
@@ -18,7 +23,7 @@
  * GtkdocIfaceInterface:
  * @parent: this is a bug :/
  *
- * class data of gtk-doc unit test class
+ * class data of gtk-doc unit test interface
  */
 struct _GtkdocIfaceInterface {
   GTypeInterface parent;

Modified: trunk/tests/gobject/src/gobject.c
==============================================================================
--- trunk/tests/gobject/src/gobject.c	(original)
+++ trunk/tests/gobject/src/gobject.c	Mon May  5 10:41:47 2008
@@ -5,7 +5,14 @@
  * This file contains non-sense code for the sole purpose of testing the docs.
  * We can link to the #GtkdocObject:otest property and the #GtkdocObject::otest
  * signal.
- * A new instance can be created using the gtkdoc_object_new() function.
+ * A new instance can be created using the gtkdoc_object_new() function. The
+ * whole lifecycle usualy looks like shown in this example: |[
+ * GObject *myobj;
+ * 
+ * myobj = gtkdoc_object_new();
+ * // do somehing
+ * g_object_unref (myobj);
+ * ]|
  */
 
 #include <glib.h>