gtk-doc r555 - in trunk: . help/manual/C

[stefkost svn gnome org]

Author: stefkost
Date: Wed Apr  9 13:12:11 2008
New Revision: 555
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=555&view=rev

Log:
	* HACKING:
          Some releasing info.
	* gtkdoc-mkdb.in:
	  Print file/line number in warning.
	* help/manual/C/gtk-doc-manual.xml:
	  Some docs for what the <module>-overrides.txt file is for.



Modified:
   trunk/ChangeLog
   trunk/HACKING
   trunk/gtkdoc-mkdb.in
   trunk/help/manual/C/gtk-doc-manual.xml

Modified: trunk/HACKING
==============================================================================
--- trunk/HACKING	(original)
+++ trunk/HACKING	Wed Apr  9 13:12:11 2008
@@ -20,11 +20,18 @@
 svn cp svn+ssh://<user>@svn.gnome.org/svn/gtk-doc/trunk svn+ssh://<user>@svn.gnome.org/svn/gtk-doc/tags/GTK_DOC_1_9/
 
 scp gtk-doc-1.9.tar.gz <user>@master.gnome.org:
+scp NEWS <user>@master.gnome.org:gtk-doc-1.9.news
+scp ChangeLog-1.9 <user>@master.gnome.org:gtk-doc-1.9.changes
 ssh <user>@master.gnome.org
 install-module gtk-doc-<ver>.tar.gz
 
+(how to install the 'gtk-doc-1.9.news' and 'gtk-doc-1.9.changes')
+
 bump versions in:
   add delimiter to ChangeLog
   configure.in
   help/manual/C/gtk-doc-manual.xml
 
+if we want a icon on the newsfeed, we should copy a icon like on
+  http://ftp.acc.umu.se/pub/GNOME/sources/rhythmbox/rhythmbox.png
+

Modified: trunk/gtkdoc-mkdb.in
==============================================================================
--- trunk/gtkdoc-mkdb.in	(original)
+++ trunk/gtkdoc-mkdb.in	Wed Apr  9 13:12:11 2008
@@ -2913,7 +2913,7 @@
 		    push (@params, $return_desc);
 		    if ($return_style eq 'broken') {
 			print <<EOF;
-WARNING: Free-form return value description in $symbol.
+WARNING: Free-form return value description in $symbol: $file:$.
          Use `Returns:' to avoid ambiguities.
 EOF
 		    }

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	Wed Apr  9 13:12:11 2008
@@ -138,11 +138,19 @@
           <para>
             <guilabel>Gathering information about the code.</guilabel>
 
-            <application>gtkdoc-scan</application> scans the header files of the code looking for declarations of
-            functions, macros, enums, structs, and unions. It creates a list of the
+            <application>gtkdoc-scan</application> scans the header files of the
+            code looking for declarations of functions, macros, enums, structs, and unions.
+            It creates the file <filename>&lt;module&gt;-decl-list.txt</filename> containg a list of the
             declarations, placing them into sections according to which header file they
-            are in. The author can rearrange the sections, and the order of the
+            are in. On the first run this file is copied to <filename>&lt;module&gt;-sections.txt</filename>
+            The author can rearrange the sections, and the order of the
             declarations within them, to produce the final desired order.
+            The second file it generates is <filename>&lt;module&gt;-decl.txt</filename>.
+            This file conatins the full declarations found by the scanner. If for
+            some reason one would like some sybols to show up in the docs, where
+            the full declaration cannot be found by th scanner or the declaration
+            should appear differently, one can place enties similar to the ones in
+            <filename>&lt;module&gt;-decl.txt</filename> into <filename>&lt;module&gt;-overrides.txt</filename>.
 
             <application>gtkdoc-scanobj</application> can also be used to dynamically query a library about
             any GtkObject subclasses it exports. It saves information about each