In a sense I'm following the time honoured tradition of throwing one away, namely the Getting Started Guide on the wiki. I'm shifting pod from there into the files.
At the moment I'm just building a big index.html list and using the default html formatting from Pod-Simple, but this will change soon.
I think the trick is to model the project with perl modules so that it's straightforward to extract and compose information. I already have the basis for this, which I'll check in any day now.
Mike
On 30 Jan 2004, at 19:23, Tim Bunce wrote:
Would doxygen be of use here? http://www.doxygen.org/
Here's an example use http://www.speex.org/API/refman/speex__bits_8h.html#a2
Follow the links, including to the annotated source file.
Tim.
On Thu, Jan 29, 2004 at 07:20:50PM +0100, Michael Scott wrote:I've add inline docs to everything in src (except for malloc.c and malloc-trace.c).
At times I wondered whether this was the right thing to do. For
example, in mmd.c, where Dan had already created a mmd.pod, I ended up
duplicating information. At other times I reckoned that what was needed
was an autodoc. Other times the best I could do was rephrase the
function name. All issues to address in phase 2.
Next I think, for a bit of light relief, I'll do the examples.
For those who want to browse:
http://homepage.mac.com/michael_scott/Parrot/docs/html/
Mike
