Fwd: API Documentation 1

Jon jon_p_griffiths at yahoo.com
Sat Mar 15 12:18:56 CST 2003


This one didn't seem to make it through last time:

----------  Forwarded Message  ----------

Hi,

Start of a few patches improving the generated API docs:
Adds docbook and (rather sexy IMO) html output, and makes the manpages nicer.
Also provides a mechanism for documenting exported com interfaces and other
things Winelib users should know (next patch is to
documentation/documentation.sgml, you can read the details there).

Apply, run ./configure, make htmlpages, point your browser at
documentation/html/index.html, then immediately start sending patches for
documentation glitches :-)

License: X11

Cheers,
Jon

ChangeLog:

  Jon Griffiths <jon_p_griffiths at yahoo.com>

  +tools/c2man.pl
   Improve the look/content of the man page output
   Generate for all exported functions (that have docs)
   Add dll summary page, HTML and SGML output

  +makefile.in
   Fix htmlpages target to use 'doc-html' in subdirs
   Add sgmlpages target for making a docbook 'Wine API Guide'
   Only make html/sgml api docs under dlls dir (_much_ faster)

  +make.rules.in
   Get rid of olsolete $MANSPECS
   Add $api_manext for api-doc manual section
   Update rules for doc generation

  +documentation/Makefile.in
   Get rid of references to 3w - use $api_manext
   Install the api man pages if they were generated
   Remove the HTML and SGML output on 'make clean'

-------------------------------------------------------

-------------- next part --------------
A non-text attachment was scrubbed...
Name: doc_1.diff
Type: text/x-diff
Size: 69455 bytes
Desc: not available
Url : http://www.winehq.org/pipermail/wine-patches/attachments/20030315/c9aebd7d/doc_1.bin


More information about the wine-patches mailing list