Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.sys.acorn.programmer > #1264

Generate StrongHelp and HTML documentation from source code

Show all headers | View raw

Some of you might have noticed the "C99" manual I released recently, in
StrongHelp and HTML formats. That's still an ongoing work, and I'll be
making a new version soon.

But for now, I've released the tool I wrote to create these manuals. It
could be grandly described as a "documentation generation system", albeit a
very slimline one.

Called "MakeHelp", this tool allows you to embed documentation inside C
source code, using markup inside "active comments". MakeHelp will then scan
your source code and generate a StrongHelp manual (or HTML).

As a simple example, here's an extract from the standard C library's
string.h file, with added markup:

/**fn: strchr */
char *strchr(const char * /*s*/, int /*c*/);
   /*
    * locates the first occurence of c (converted to an char) in the string
    * pointed to by s (including the terminating null character).
    + Returns: a pointer to the located character, or a null pointer if the
    *          character does not occur in the string.
    **/

You can see the HTML produced from this here: 
  http://www.btinternet.com/~rik.griffin/c99-online/string.html#strchr

Other documentation generation systems are available, but MakeHelp's main
advantage is that it will create StrongHelp manuals, complete with keyword
lookup from your favourite editor.

You can download MakeHelp from:
  http://www.btinternet.com/~rik.griffin/makehelp.html

You'll also need Python 2.4, and StrongHelp itself.

There's an extensive Help file included, but if there are any questions
about how it works, or any other comments, bug reports, etc, please get in
touch either here or via email.

-- 
Rik Griffin
Standard disclaimer, not speaking for anyone but myself, blah blah

Back to comp.sys.acorn.programmer | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

Generate StrongHelp and HTML documentation from source code Rik Griffin <nospam@denbridgemarine.com> - 2012-01-05 13:16 +0000
  Re: Generate StrongHelp and HTML documentation from source code Gerph <gerph@gerph.org> - 2012-01-06 11:45 -0800
    Re: Generate StrongHelp and HTML documentation from source code Adam <news@snowstone.org.uk> - 2012-01-13 14:33 -0800

csiph-web