| Re: [AD] naturaldocs for 4.3 |
[ Thread Index |
Date Index
| More lists.liballeg.org/allegro-developers Archives
]
On 2006-12-20, Peter Wang <tjaden@xxxxxxxxxx> wrote:
> On 2006-12-19, Elias Pschernig <elias@xxxxxxxxxx> wrote:
> > On Mon, 2006-12-18 at 11:02 +1100, Peter Wang wrote:
> > > Hi, the following patch adds some tags for inline documentation using
> > > NaturalDocs (http://naturaldocs.org/). You have can a look at what the
> > > output looks like at:
> > >
> > > http://home.exetel.com.au/tjaden/a5/naturaldocs/html/
> > >
> > > Not great, but better than no documentation, and easier than writing
> > > makedoc docs. I thought it might serve as an *interim* solution for
> > > documenting the 4.3 API. Anyone mind if I commit the patch?
> > >
> >
> > Yes, looks very nice. And now with the API possibly changing a lot,
> > inline documentation indeed is preferable. (I'm also for switching back
> > to something makedoc-like in the future though.)
Committed the patch.
> >
> > Oh, and can it also be made to (separately) document internals?
>
> Yes, should be possible. I'll take a look.
Turns out it's not supported directly, but we can get a similar effect
using a workaround. We just have to set it up so one configuration
tells NaturalDocs to recognise "Internal function:" (or whatever), and
another configuration to ignore it. I'll do that some other time.
Peter