[Gnu3dkit-discuss] Re: GeometryKit documentation

[Brent Gulanowski]

On Monday, October 21, 2002, at 12:16  PM, Philippe C.D. Robert wrote:

> On Monday, October 21, 2002, at 05:19  Uhr, Brent Gulanowski wrote:
> > On Monday, October 21, 2002, at 10:58  AM, Brent Gulanowski wrote:
> > > On Monday, October 21, 2002, at 10:47  AM, Brent Gulanowski wrote:
> > > > On Sunday, October 20, 2002, at 09:55  AM, Philippe C.D. Robert 
> > > > wrote:
> > > >
> > > > > Hi,
> > > > >
> > > > > I started to create an API reference documentation for the 
> > > > > GeometryKit using HeaderDoc just yesterday. The HTML files are not 
> > > > > yet in CVS but the comments (as far as they exist already), so to 
> > > > > get the reference, run HeaderDoc on the GeometryKit source 
> > > > > directory, and voila, there it is...:-) There is still some 
> > > > > mistery going on though, ie. not all TOCs are correct (see 
> > > > > MatrixFunc for example), if anyone knows what is going on there, 
> > > > > please let me >>> know!
> > > > MatrixFunc comes out fine for me -- the methods are re-organized 
> > > > alphabetically, however. G3DBox, Line, Quaternion, Sphere, Plane, 
> > > > Intersecting and all the Matrices aren't recognized as ObjC classes 
> > > > and their method documentation is being ignored.
> > >
> > > The problem is definitely that headerdoc doesn't like @class being 
> > > used by Objective-C grammar. All of the headers I created that had 
> > > @class preprocessor directive did not produce complete documenation 
> > > html.
> >
> > This has been filed as bug #136 at
> > http://opendarwin.org/bugzilla/query.cgi
> > (requires an account to login)
>
> Uhm, unless I miss sth this works for me - what is the problem exactly 
> (well at least for these classes which do contain some description)?
>
> BTW bugzilla is only configured for HeaderDoc 6.x, but 7.2 is the 
> current version...

Here's part of the header2HTML.pl output:

Processing G3DIntersecting.h
Unknown class type (known: cpp, objC)

Processing G3DLine.h
Unknown class type (known: cpp, objC)

Processing G3DMatrix3d.h
Unknown class type (known: cpp, objC)

Processing G3DMatrix3f.h
Unknown class type (known: cpp, objC)

Processing G3DMatrix4d.h
Unknown class type (known: cpp, objC)

Processing G3DMatrix4f.h
Unknown class type (known: cpp, objC)

Processing G3DMatrixFunc.h

[etc...]

You didn't get these errors? In the output doc files, the methods are 
not produced.
--

Don't expect the worst, but plan for it anyway. (Me)