[DOCS] Updated documentation in src

2004-01-29 Thread Michael Scott
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

Re: [DOCS] Updated documentation in src

2004-01-29 Thread Matt Fowles
Mike~ You rock. That is really nice. Matt 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 duplicati

Re: [DOCS] Updated documentation in src

2004-01-29 Thread Leopold Toetsch
Matt Fowles <[EMAIL PROTECTED]> wrote: [ another TOFU [1] ] AOL leo > Mike~ > You rock. That is really nice. > Matt > 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

Re: [DOCS] Updated documentation in src

2004-01-30 Thread Vishal Vatsa
On Thursday 29 January 2004 18:20, Michael Scott wrote: > For those who want to browse: > > http://homepage.mac.com/michael_scott/Parrot/docs/html/ > > Mike Thanks you defn. rock... -- Vishal Vatsa Dept. of Computer Sc. NUI Maynooth

Re: [DOCS] Updated documentation in src

2004-01-30 Thread Tim Bunce
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 i

Re: [DOCS] Updated documentation in src

2004-01-30 Thread Michael Scott
I haven't ruled out something like that in the long term, but what I'm trying achieve at the moment is just to see some pod everywhere. This has the merit that I visit every file and ensure that some basic information gets provided for the newbies - my target audience. In a sense I'm following

Re: [DOCS] Updated documentation in src

2004-02-01 Thread Tim Bunce
Great, thanks. Tim. On Sat, Jan 31, 2004 at 01:05:02AM +0100, Michael Scott wrote: > I haven't ruled out something like that in the long term, but what I'm > trying achieve at the moment is just to see some pod everywhere. This > has the merit that I visit every file and ensure that some basic