Re: [Gnu3dkit-dev] White Paper and API reference

[Philippe C . D . Robert]

Hi,

the point here is that the API reference has to be *generated*. 
Otherwise one cannot keep it in sync, that's reality. So the way it 
works is that API documentation is added to the header file, which is 
then parsed by ie. HeaderDoc or AutoDoc to generate the reference. I 
don't think the output quality is thereby worse than with Word - you 
can generate TeX, HTML or whatever.

I will not consider using Frame nor Word because they are proprietary, 
incl. their format. Not anyone has Word or Frame, but anyone should be 
able to contribute!

And remember, the GNU 3DKit is a GNU project...:-)

-Phil

On Freitag, Oktober 11, 2002, at 03:15  Uhr, Matt Brandt wrote:

> I'm more of a Frame and Word kind of guy. It's been a long time since 
> I've used Tex, but I'll take a look before starting anything. I also 
> haven't tried the headerdoc stuff, but I think a word processor would 
> turn out a nicer product in general. I also have inDesign, Appleworks 
> (yuk), and ThinkFree. There is probably a good solution in there 
> somewhere. If Frame was OS X native, it would be an easy decision, but 
> as it is I have to run it under Classic (ugh!).
>
> Matt
>
> On Friday, October 11, 2002, at 12:51 AM, Philippe C.D. Robert wrote:
>
> > Hi,
> >
> > I prefer TeX for nice looking documents. If we decide to go with that 
> > (using ie. the free, excellent TeXShop on Mac OS X), I could also 
> > upload the appropriate files of my early programmers' guide which 
> > could be turned into a white paper/documentation. What do you think?
> >
> > WRT the generated API reference, what tool should we use? Is Apple's 
> > HeaderDoc finally able to handle Objective-C?
> >
> > -Phil
> > --
> > Philippe C.D. Robert
> > http://www.nice.ch/~phip
> >
> >
> >
> > _______________________________________________
> > Gnu3dkit-dev mailing list
> > address@hidden
> > http://mail.gnu.org/mailman/listinfo/gnu3dkit-dev
>
>
>
> _______________________________________________
> Gnu3dkit-dev mailing list
> address@hidden
> http://mail.gnu.org/mailman/listinfo/gnu3dkit-dev
--
Philippe C.D. Robert
http://www.nice.ch/~phip