summaryrefslogtreecommitdiffstats
path: root/doc/doxygen-link.py
Commit message (Collapse)AuthorAgeFilesLines
* doc: fix doxygen-link.py by skipping invalid entries in libnl.dictThomas Haller2014-06-251-9/+32
| | | | | | | | | | | | | | | | | | | | | | Newer versions of doxygen (on Fedora20) treat the documentation slightly different so that the following entires end up in libnl.dict: \=api/group__attr.html#ga769cc7bd882aab17c3740dd83329d7e6 »·······»·······NLA_PUT=api/group__attr.html#ga769cc7bd882aab17c3740dd83329d7e6 NLA_PUT=api/group__attr.html#ga769cc7bd882aab17c3740dd83329d7e6 Especially, replacing r'\' breaks the generated html documentation. Extend doxygen-link.py to strip whitespaces from the name and skip over r'\'. Also, when replacing the words in the output file, match them using word boundaries r'\b'. Also, don't print an additional newline after each processed line. Acked-by: Thomas Graf <tgraf@suug.ch> Signed-off-by: Thomas Haller <thaller@redhat.com>
* doxygen-link: Be python3 compatibleThomas Graf2013-10-221-1/+1
| | | | | Reported-by: Teto <mattator@gmail.com> Signed-off-by: Thomas Graf <tgraf@suug.ch>
* Move to asciidocThomas Graf2011-03-311-0/+20
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