gtk-doc r694 - in trunk: . doc examples

[stefkost svn gnome org]

Author: stefkost
Date: Thu Feb 26 15:18:16 2009
New Revision: 694
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=694&view=rev

Log:
	* doc/gtkdoc.dot:
	  Improve. scan only checks headers, while mkdb scans sources and
	  headers.
	* examples/Makefile.am:
	  Document more variables.



Modified:
   trunk/ChangeLog
   trunk/doc/gtkdoc.dot
   trunk/examples/Makefile.am

Modified: trunk/doc/gtkdoc.dot
==============================================================================
--- trunk/doc/gtkdoc.dot	(original)
+++ trunk/doc/gtkdoc.dot	Thu Feb 26 15:18:16 2009
@@ -19,7 +19,8 @@
     gtkdoc_check [label="gtkdoc-check",shape="ellipse" ];
 
     /* file nodes */
-    sources [label="source code"];
+    headers [label="headers\nall headers under DOC_SOURCE_DIR\n+EXTRA_HFILES\n-IGNORE_HFILES"];
+    sources [label="source code\nall files under DOC_SOURCE_DIR\nmatching SUFFIXES or *.{c,h}"];
     binary [label="compiled binary"];
     xml [label="docbook xml"];
     html [label="html"];
@@ -38,9 +39,9 @@
  
     /* tool invokation */
     gtkdoc_scan -> gtkdoc_scangobj -> gtkdoc_mkdb -> gtkdoc_mkhtml -> gtkdoc_fixxref -> gtkdoc_rebase -> gtkdoc_check [style="dotted"];
-    
+
     /* file usage */
-    sources -> gtkdoc_scan;
+    headers -> gtkdoc_scan;
     gtkdoc_scan -> module_sections [label="--rebuild-sections", style="dashed"];
     gtkdoc_scan -> module_types [label="--rebuild-types", style="dashed"];
     gtkdoc_scan -> module_decl;
@@ -53,7 +54,8 @@
     gtkdoc_scangobj -> module_interfaces;
     gtkdoc_scangobj -> module_prerequisites;
     gtkdoc_scangobj -> module_args;
-    
+
+    sources -> gtkdoc_mkdb;
     module_sections -> gtkdoc_mkdb;
     module_decl -> gtkdoc_mkdb;
     module_signals -> gtkdoc_mkdb;

Modified: trunk/examples/Makefile.am
==============================================================================
--- trunk/examples/Makefile.am	(original)
+++ trunk/examples/Makefile.am	Thu Feb 26 15:18:16 2009
@@ -52,7 +52,11 @@
 HFILE_GLOB=
 CFILE_GLOB=
 
-# Header files to ignore when scanning.
+# Extra header to include when scanning, which are not under DOC_SOURCE_DIR
+# e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
+EXTRA_HFILES=
+
+# Header files to ignore when scanning. Use base file name, no paths
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
 IGNORE_HFILES=