]> sourceware.org Git - newlib-cygwin.git/commit
winsup/doc: Convert cygwin-api function documentation to refentry elements
authorJon TURNEY <jon.turney@dronecode.org.uk>
Tue, 16 Jun 2015 17:52:37 +0000 (18:52 +0100)
committerJon TURNEY <jon.turney@dronecode.org.uk>
Thu, 18 Jun 2015 10:32:03 +0000 (11:32 +0100)
commitcf1c6cd395c130ffd4883dc34af0cbb22a59eba1
treec9ab73dfd1a6dfa30128dff48c6f1e5fe74d030a
parenta197d1d5043c6de7073517463eb97ad224724712
winsup/doc: Convert cygwin-api function documentation to refentry elements

Convert cygwin-api from using a sect2 element to using a refentry element for
each function.  This makes it possible to generate manpage-style output for
those elements.

Note that the chunked html now generates a page for each function, rather than
one containing all functions.

Also:

Remove pointless and incorrect date

Move introductory paragraph from the first section to the start of the chapter

Add a funcsynopsisinfo element with the header file to be included to each
function prototype

Remove extern "C" which doesn't process into all formats successfully

2015-06-17  Jon Turney  <jon.turney@dronecode.org.uk>

* cygwin-api.xml: Move introductory paragraph here.
* logon-funcs.xml: Convert from using a sect2 element to using a
refentry element for each function.
* misc-funcs.xml: Ditto.
* path.xml: Ditto.

Signed-off-by: Jon TURNEY <jon.turney@dronecode.org.uk>
winsup/doc/ChangeLog
winsup/doc/cygwin-api.xml
winsup/doc/logon-funcs.xml
winsup/doc/misc-funcs.xml
winsup/doc/path.xml
This page took 0.030404 seconds and 5 git commands to generate.