Re: GeometryKit documentation

Brent Gulanowski <[email protected]> Mon, 21 Oct 2002 10:58:54 -0400
Newsgroups gmane.comp.gnu.3dkit.devel,gmane.comp.gnu.3dkit.general
Message-ID <[email protected]>
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.

--
Brent Gulanowski				[email protected]

I bought some batteries... but they weren't included... so I had to buy 
them again.	- Stephen Wright