gtk-doc r570 - in trunk: . tests/gobject/docs tests/gobject/docs-tmpl

[stefkost svn gnome org]

Author: stefkost
Date: Mon Jun  2 08:44:00 2008
New Revision: 570
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=570&view=rev

Log:
	* TODO:
	  tody up and add some comments regarding HTML_DIR.
	* gtkdoc-fixxref.in:
	  HTML_DIR is not neccesarily set.
	* gtkdoc-mkhtml.in:
	  Fix uninstalled.
	* tests/gobject/docs-tmpl/tester-docs.xml:
	* tests/gobject/docs/tester-docs.xml:
	  Add more chapter id's and experiment with an index chapter.



Modified:
   trunk/ChangeLog
   trunk/TODO
   trunk/gtkdoc-fixxref.in
   trunk/gtkdoc-mkhtml.in
   trunk/tests/gobject/docs-tmpl/tester-docs.xml
   trunk/tests/gobject/docs/tester-docs.xml

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Mon Jun  2 08:44:00 2008
@@ -15,6 +15,8 @@
 
 
 Developer can also add items here :)
+
+= Tracing =
 * there is a bunch of #print statements for tracing
   => add a sub Trace() to gtkdoc-common.pl
   => use @TRACE@ "..." and depending on configure flag
@@ -23,10 +25,19 @@
      should be a function and the function should support loglevels and an
        envar to enable/disable conditionally;
 
-More abbreviations:
+= More abbreviations =
 * expand urls
 
-Testing:
+= Testing =
 cd test/gobject
 diff -u --exclude="Makefile*" docs docs-tmpl | diffstat
 
+= Issues =
+* gtkdoc-fixxref makefile targets use $HTML_DIR
+  * HTML_DIR: The directory where gtk-doc generated documentation is installed
+  * automake exports $htmldir which is by default:
+    ${prefix}/share/doc/${PACKAGE_TARNAME}
+  * the Makefile uses $(DESTDIR)$(TARGET_DIR)
+    where TARGET_DIR = $(HTML_DIR)/$(DOC_MODULE)
+    http://www.gnu.org/software/libtool/manual/automake/DESTDIR.html
+

Modified: trunk/gtkdoc-fixxref.in
==============================================================================
--- trunk/gtkdoc-fixxref.in	(original)
+++ trunk/gtkdoc-fixxref.in	Mon Jun  2 08:44:00 2008
@@ -44,7 +44,7 @@
 	      'extra-dir' => \ EXTRA_DIRS,
 	      'version' => \$PRINT_VERSION,
 	      'help' => \$PRINT_HELP);
-GetOptions(\%optctl, "module=s", "module-dir=s", "html-dir=s", "extra-dir=s@",
+GetOptions(\%optctl, "module=s", "module-dir=s", "html-dir:s", "extra-dir=s@",
 	"version", "help");
 
 if ($PRINT_VERSION) {

Modified: trunk/gtkdoc-mkhtml.in
==============================================================================
--- trunk/gtkdoc-mkhtml.in	(original)
+++ trunk/gtkdoc-mkhtml.in	Mon Jun  2 08:44:00 2008
@@ -4,6 +4,8 @@
 usage="\
 Usage: gtkdoc-mkhtml MODULE DRIVER_FILE"
 
+#echo "args $0\n";
+
 if test "x$1" = "x--version"; then
       echo "@VERSION@"
       exit 0
@@ -18,7 +20,7 @@
 document=$2
 
 # FIXME: this is a hack to run uninstalled
-if test "x$0" = "x../../../../gtkdoc-mkhtml" ; then
+if test "x$0" = "x../../../gtkdoc-mkhtml" ; then
       # uninstalled
       gtkdocdir=`dirname $0`
 else
@@ -28,8 +30,6 @@
       gtkdocdir= datadir@/gtk-doc/data
 fi
 
-declaration=$gtkdocdir/gtk-doc.dcl
-
 if head -n 1 $document | grep "<?xml" > /dev/null; then
   is_xml=true
 else
@@ -52,7 +52,7 @@
       $gtkdocdir/gtk-doc.dcl $document || exit $?
 fi
 
-# copy navigation images to html directory ...
+# copy navigation images and stylesheets to html directory ...
 cp -f $gtkdocdir/*.png .
 cp -f $gtkdocdir/*.css .
 

Modified: trunk/tests/gobject/docs-tmpl/tester-docs.xml
==============================================================================
--- trunk/tests/gobject/docs-tmpl/tester-docs.xml	(original)
+++ trunk/tests/gobject/docs-tmpl/tester-docs.xml	Mon Jun  2 08:44:00 2008
@@ -19,7 +19,7 @@
     </para>
   </chapter>
 
-  <chapter>
+  <chapter id="main-api">
     <title>Tests</title>
     <xi:include href="xml/object.xml"/>
     <xi:include href="xml/iface.xml"/>
@@ -30,12 +30,14 @@
      <xi:include href="xml/tree_index.sgml" />
   </chapter>
 
-  <index id="api-index">
-    <title>API Index</title>
-  </index>
-  <index id="deprecated-api-index" role="deprecated">
-    <title>Index of deprecated API</title>
-  </index>
+  <!--chapter id="indices"-->
+    <index id="api-index">
+      <title>API Index</title>
+    </index>
+    <index id="deprecated-api-index" role="deprecated">
+      <title>Index of deprecated API</title>
+    </index>
+  <!--/chapter-->
 
   <glossary>
     <glossdiv id="glossary-X"><title>X</title>

Modified: trunk/tests/gobject/docs/tester-docs.xml
==============================================================================
--- trunk/tests/gobject/docs/tester-docs.xml	(original)
+++ trunk/tests/gobject/docs/tester-docs.xml	Mon Jun  2 08:44:00 2008
@@ -19,7 +19,7 @@
     </para>
   </chapter>
 
-  <chapter>
+  <chapter id="main-api">
     <title>Tests</title>
     <xi:include href="xml/object.xml"/>
     <xi:include href="xml/iface.xml"/>
@@ -30,12 +30,14 @@
      <xi:include href="xml/tree_index.sgml" />
   </chapter>
 
-  <index id="api-index">
-    <title>API Index</title>
-  </index>
-  <index id="deprecated-api-index" role="deprecated">
-    <title>Index of deprecated API</title>
-  </index>
+  <!--chapter id="indices"-->
+    <index id="api-index">
+      <title>API Index</title>
+    </index>
+    <index id="deprecated-api-index" role="deprecated">
+      <title>Index of deprecated API</title>
+    </index>
+  <!--/chapter-->
 
   <glossary>
     <glossdiv id="glossary-X"><title>X</title>