gtk-doc r653 - trunk

[stefkost svn gnome org]

Author: stefkost
Date: Thu Jan 22 16:33:03 2009
New Revision: 653
URL: http://svn.gnome.org/viewvc/gtk-doc?rev=653&view=rev

Log:
	* README:
	  Point to the right docs.
	* TODO:
	  More tinking.
	* style.css:
	  Remove one commented out item.



Modified:
   trunk/ChangeLog
   trunk/README
   trunk/TODO
   trunk/style.css

Modified: trunk/README
==============================================================================
--- trunk/README	(original)
+++ trunk/README	Thu Jan 22 16:33:03 2009
@@ -64,6 +64,5 @@
 Most distributions now have packages for all of these, so I would strongly
 advise that you grab those.
 
-See the documentation in the docs directory for more information, especially
-the setting-up.txt file which describes how to set up your application or
-library to use gtk-doc.
+See the documentation in the help/manual directory for more information. You can
+read it e.g. with yelp file://$PWD/help/manual/C/gtk-doc-manual.xml

Modified: trunk/TODO
==============================================================================
--- trunk/TODO	(original)
+++ trunk/TODO	Thu Jan 22 16:33:03 2009
@@ -167,11 +167,28 @@
   - unfortunately we can't link to symbols
   - linking to files is difficult as in gtkdoc we have modules
 
+
 = docbook xml =
-Its tedious to write large amounts of docbook. Can we offer integration with
-asciidoc (http://www.methods.co.nz/asciidoc/)? This way the master document
-could be written musch easier. It would be cool if we could use the asciidoc
-markup in source-comments also.
+Its tedious to write large amounts of docbook.
+
+== more macros ==
+We need parametric, user definable macros.
+|[ ... ]| - programlistings
+|macro(arg1,arg2,...)[ ... ]| - call macro, pass args as parameters, content
+  of [] on stdin or as a file, get output on stdout or file and replace the macro
+  with it
+=== example macros ===
+|highlight(c)[...]| - highlight source code
+|dot(abc.svg)[...]| - format dot graph and include result as mediaobject
+
+=== where to define macros ===
+* system wide and with the package, <prefix>/share/gtk-doc/macros, $(srcdir)
+* prefix for custom macros?
+
+== ascii doc as a frontend ==
+Can we offer integration with asciidoc (http://www.methods.co.nz/asciidoc/)?
+This way the master document could be written much easier. It would be cool if
+we could use the asciidoc markup in source-comments also.
 
 == extract other bits and pieces ==
 === library api ==
@@ -184,6 +201,8 @@
 
 === Wiki imports ===
 
+
+
 = styling =
 == warnings ==
 xsl produces inline style tag for warnings (e.g. deprecation). We could add a
@@ -223,6 +242,8 @@
 * allow <!-- language="C" --> comments after |[
 * we need to catch those when processing the docbook and expanding the |[
 
+
+
 = documentation best practises #518427 =
 * we'd like offer a more complete skelleton
   * structure

Modified: trunk/style.css
==============================================================================
--- trunk/style.css	(original)
+++ trunk/style.css	Thu Jan 22 16:33:03 2009
@@ -217,7 +217,6 @@
   margin: 0;
   padding: 0em 0em 0em 2.5em;
   font-family: "Courier New", Courier, monospace;
-  /*list-style-position: outside;*/
   list-style-type: decimal-leading-zero;
   /* tango:sky blue 0.5 */
   background: #a6c5e3;