dect
/
libnl
Archived
13
0
Fork 0
Commit Graph

5 Commits

Author SHA1 Message Date
Thomas Graf 2fbab02ba8 doc: add section about addressing
Adds a new section to netlink fundamentals explaining the common
addressing use cases and illustrates kernel->user, user->user,
and user->kernel communication.
2012-05-09 15:02:40 +02:00
Thomas Graf c79ab52d47 ignore various generated files 2011-07-21 16:39:29 +02:00
Thomas Graf 50074732af more documentation updates
- improved stylesheets for both doxygen and asciidoc
 - use of xml doxygen layout
 - python script to resolve <<foo>> asciidoc references to
   <<foo, title>> based on the target caption
 - graphics for netlink and netlink error headers
 - more link documentation
2011-07-21 16:24:31 +02:00
Thomas Graf 7d484555f6 Documentation updates
- update to asciidoc 8.6.5
- added doc/README
- switched to toc2
- started adding link documentation
2011-07-18 08:50:42 +02:00
Thomas Graf 350b15f9d1 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
2011-03-31 14:25:57 +02:00