diff options
| author | Stefan Kost <ensonic@users.sf.net> | 2010-09-08 23:01:40 +0300 |
|---|---|---|
| committer | Stefan Kost <ensonic@users.sf.net> | 2010-09-08 23:01:40 +0300 |
| commit | 70abe37062ace247e8941afc73f2dba0da39a431 (patch) | |
| tree | be04f07a19f9ac7b52e36836831759bb369cc318 /README | |
| parent | 2190c4fd213dd5849f6ea04708ac3fb1bb6a5c1b (diff) | |
| download | gtk-doc-70abe37062ace247e8941afc73f2dba0da39a431.tar.gz | |
docs: small doc update
Mention in more places that tmpl-files and sgml support is legacy.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 7 |
1 files changed, 5 insertions, 2 deletions
@@ -17,7 +17,7 @@ GTK-Doc allows your documentation to be written in 2 ways: a) Embedded inside the source code in specially-formatted comments. or b) Added to the 'template' files which gtk-doc outputs after scanning all - the header files and parsing the declarations. + the header files and parsing the declarations (deprecated now). From these source code comments and template files GTK-Doc generates a Docbook XML (or SGML) document, which is then transformed into HTML. @@ -25,6 +25,9 @@ The generated HTML documentation can be browsed in an ordinary web browser or by using the special Devhelp API browser (see http://developer.imendio.com/wiki/Devhelp). +Please don't use template files in new projects. Support for for those will +be removed at some point in the future (together with gtkdoc-mktmpl). Please +also use DoxBook XML instead of DocBook SGML. Requirements ============ @@ -41,7 +44,7 @@ The DocBook XML DTD. The DocBook XSL Stylesheets. http://docbook.sourceforge.net/projects/xsl/ -libxslt & libxml2 2.3.6. +libxslt & libxml2 >= 2.3.6. http://xmlsoft.org/ |