newlib/winsup/doc/cygwin-api.xml
Jon TURNEY cf1c6cd395 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>
2015-06-18 11:32:03 +01:00

31 lines
744 B
XML

<?xml version="1.0" encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<book id="cygwin-api" xmlns:xi="http://www.w3.org/2001/XInclude">
<bookinfo>
<title>Cygwin API Reference</title>
<xi:include href="legal.xml"/>
</bookinfo>
<toc></toc>
<xi:include href="posix.xml"/>
<chapter id="cygwin-functions" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>Cygwin Functions</title>
<para>
These functions are specific to Cygwin itself, and probably won't be
found anywhere else.
</para>
<xi:include href="path.xml"/>
<xi:include href="logon-funcs.xml"/>
<xi:include href="misc-funcs.xml"/>
</chapter>
</book>