[gold-devel] Documentation stuff

[Nathan Ladd]

Well, I think HeaderDoc is a good start, and would require the least amount
of going back and changing old documentation.

On 10/5/05, Justin Hibbits <jrh29 at alumni.cwru.edu> wrote:
>
> On Wednesday 05 October 2005 23:04, Nathan Ladd wrote:
> > I recommend python scripts. I think we're going to want to integrate
> > documentation generation with test script generation...they'll be
> > functioning similarly and can share a lot of code.
> >
> > BTW I have high hopes for this ML system.
> >
> > On 10/5/05, Justin Hibbits <jrh29 at alumni.cwru.edu> wrote:
> > > What do we want to use to document our code? Currently I'm using
> > > HeaderDoc from Apple, but that requires Perl which I don't want to
> use.
> > > We could write
> > > our own based on HeaderDoc, using Python, but I think something else
> is
> > > in order. Doxygen looks nice, but it's written in C++. Not such a big
> > > deal for
> > > Gold v1, if we're just using gcc, since that has a C++ compiler.
> > >
> > > What are your thoughts?
> > >
> > > - Justin
>
>
> Ok, we go with that. Now, in order to do that, we need to define a set of
> tags to use for documenting. What are required, should we model it after
> something already, or what?
>
> - Justin
>
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://icculus.org/pipermail/gold-devel/attachments/20051006/96632580/attachment.htm>