diff options
author | Stefan Kost <stefkost@src.gnome.org> | 2009-01-22 16:33:03 +0000 |
---|---|---|
committer | Stefan Kost <stefkost@src.gnome.org> | 2009-01-22 16:33:03 +0000 |
commit | 23ad6e6f9928999c503eacec22c659a881f47ea4 (patch) | |
tree | d2c20343e5e9b727fa288b0e216678f8981c9556 /TODO | |
parent | c8c1c2ae21269a42ad704747a0d5da6dcba68854 (diff) | |
download | gtk-doc-23ad6e6f9928999c503eacec22c659a881f47ea4.tar.gz |
Point to the right docs. More tinking. Remove one commented out item.
* README:
Point to the right docs.
* TODO:
More tinking.
* style.css:
Remove one commented out item.
svn path=/trunk/; revision=653
Diffstat (limited to 'TODO')
-rw-r--r-- | TODO | 29 |
1 files changed, 25 insertions, 4 deletions
@@ -167,11 +167,28 @@ diff -u --exclude="Makefile*" docs docs-tmpl | diffstat - 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 @@ http://cgit.freedesktop.org/DeviceKit/DeviceKit/tree/doc/dbus === Wiki imports === + + = styling = == warnings == xsl produces inline style tag for warnings (e.g. deprecation). We could add a @@ -223,6 +242,8 @@ problems: * 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 |