[antlr-interest] Doxygen errors when using the C Target with ANTLR

[Jim Idle]

Well to be honest I started adding doxygen to the generated code but after looking at what you get from it I decided that it wasn't really of much help. In the next version of ANTLR doc comments of rules will be passed through to code gen and that should help.

To change the template you need to either rebuild ANTLR or set your class path up so that it finds your version of C.stg before mine. I suspect though that what you will get is not really that useful. Better to document the grammar than the generated code.

Jim

> -----Original Message-----
> From: antlr-interest-bounces at antlr.org [mailto:antlr-interest-
> bounces at antlr.org] On Behalf Of Heiko Folkerts
> Sent: Friday, January 08, 2010 5:33 AM
> To: antlr-interest at antlr.org
> Subject: [antlr-interest] Doxygen errors when using the C Target with
> ANTLR
> 
> Hi all,
> When I run doxygen over the code generated by ANTLR using the C target,
> I get the following error message in doxygen.log:
> 
> C:/Projekte/modelisar/trunk/src/TFSSParser/grammar/TFSSBaseParser.h:303
> : Warning: argument 'POinter' of command @param is not found in the
> argument list of TFSSBaseParser_tfs_SCOPE_struct::void(ANTLR3_CDECL
> *free)
> C:/Projekte/modelisar/trunk/src/TFSSParser/grammar/TFSSBaseParser.h:303
> : Warning: The following parameters of
> TFSSBaseParser_tfs_SCOPE_struct::void(ANTLR3_CDECL *free) are not
> documented:
>   parameter 'free'
> 
> I found a fitting place in c.stg and tried to fix the template to solve
> the problem, but in the generated code the errorneous code still
> exists. What have I made wrong? Any solution how to fix it?
> The Code for the mentioned file TFSSBase.h is:
> /** Function that the user may provide to be called when the
>      *  scope is destroyed (so you can free pANTLR3_HASH_TABLES and so
> on)
>      *
>      * \param POinter to an instance of this typedef/struct
>      */
> 
> Thx
> Heiko
> 
> Mit freundlichem Gruß
> Heiko Folkerts
> Systementwicklung und -design
> --
> ______________________________________________
> DAVID GmbH · Wendenring 1 · 38114 Braunschweig
> Tel.: +49 531 24379-14
> Fax.: +49 531 24379-79
> E-Mail: mailto:Heiko.Folkerts at david-bs.de
> WWW:   http://www.david-bs.de
> Eintragung: Amtsgericht Braunschweig, HRB 3167
> Geschäftsführer: Frank Ptok
> ______________________________________________
> 
> 
> 
> List: http://www.antlr.org/mailman/listinfo/antlr-interest
> Unsubscribe: http://www.antlr.org/mailman/options/antlr-interest/your-
> email-address