pasdoc-main

[Pasdoc-main] Comments for methods

[Rory S. <ror...@gm...>]

Dear list,
I am not sure wether this has been asked before. I had a lot of trouble
trying to search the mailing list using google...

I have defined my method comments in the implementation section.
PasDoc does not seem to recognize any of them comments.
if I place the comments in the interface section, it seems to work but this
clutters my class definition.

Any idea's are very welcome.

Rory Slegtenhorst
rory dot slegtenhorst at gmail dot com

Re: [Pasdoc-main] Comments for methods

[Michalis K. <mic...@gm...>]

2009/9/11 Rory Slegtenhorst:
> Dear list,
> I am not sure wether this has been asked before. I had a lot of trouble
> trying to search the mailing list using google...
> I have defined my method comments in the implementation section.
> PasDoc does not seem to recognize any of them comments.
> if I place the comments in the interface section, it seems to work but this
> clutters my class definition.
> Any idea's are very welcome.

Currently only interface comments are extracted. Parsing
implementation and handling comments there was asked for many times,
but so far it's not implemented. If you want to help, read
http://pasdoc.sipsolutions.net/WantedFeaturesParsingImplementation and
http://sourceforge.net/mailarchive/forum.php?thread_name=20051214225752.GA17622%40localhost&forum_name=pasdoc-main

Michalis

Re: [Pasdoc-main] Comments for methods

[Hans-Peter D. <DrD...@ao...>]

Rory Slegtenhorst schrieb:

> I have defined my method comments in the implementation section.
> PasDoc does not seem to recognize any of them comments.

Right. The parser only can handle the interface section.

> if I place the comments in the interface section, it seems to work but 
> this clutters my class definition.

Right :-(

The PasDoc2 GUI allows to add descriptions to external files.


> Any idea's are very welcome.

FpDoc uses the FPC parser, which is kept up-to-date by the FPC people. 
I'd prefer to use that parser even in PasDoc, so that also the 
implementation section can be parsed, but couldn't make it work yet :-(

DoDi