diff options
author | Thomas Graf <tgraf@suug.ch> | 2011-03-31 14:25:57 +0200 |
---|---|---|
committer | Thomas Graf <tgraf@suug.ch> | 2011-03-31 14:25:57 +0200 |
commit | 350b15f9d13fdb33e63d2b9cb09872e22bfbe5c9 (patch) | |
tree | 8ef7d3b62be8cc3dae5f48bccb27e53b9c02a0e1 /doc/Doxyfile.in | |
parent | 7c620500bbca24c3d18b731756c375a45bb0fcba (diff) | |
download | libnl-350b15f9d13fdb33e63d2b9cb09872e22bfbe5c9.tar.gz |
Move to asciidoc
The core library documentation has been converted to use asciidoc. It
provides better flexibility in creating documentation such as tables
and more powerful formatting rules.
The doxygen based API reference remains and three scripts have been
added to:
- gen-tags.sh: extract tag information from doxygen reference
- tags2dict.sh: generate a name=link dictionary file
- doxygen-link.py: replace all references in the asciidoc documentation
refering to API functions, struct, etc. with a link
into the doxygen API reference.
'make gendoc' continue to generate all documentation.
The following tools are required to generate documentation:
- asciidoc
- mscgen
- asciidoc mscgen plugin
- pygments
- xmlstarlet
Diffstat (limited to 'doc/Doxyfile.in')
-rw-r--r-- | doc/Doxyfile.in | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index aafebbe..9bfb711 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -662,7 +662,7 @@ EXAMPLE_RECURSIVE = NO # directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = src/img +IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program @@ -784,7 +784,7 @@ GENERATE_HTML = YES # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. -HTML_OUTPUT = html +HTML_OUTPUT = api # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank |