Re: [Pasdoc-main] Question, because "fpdoc" does not generate documentation of a console application.

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

> I have develop an application console, but when I execute fpdoc, generate
> all documentacion of units of the program, but the main program not.
>
> In the main programa is defined the class:  TMyAppv1 =
> class(TCustomApplication)
>
> which contains functions and procedures, then when generate the docs, this
> functions and procedures not are included.
>
> I use program pasdoc_gui to generate documentation. I check all possible
> options , but not generate information for this program, and I do not know
> what could be happening.
>

(I assume you mean "pasdoc", not "fpdoc". This is a mailing list about
pasdoc development, and "fpdoc" is a different program, although with
similar purpose and also open-source,
http://www.freepascal.org/docs-html/fpdoc/fpdoc.html .)

To answer your question: pasdoc currently parses only the "uses"
clause of the program files. So indeed you will never see the
documentation of any class (and its methods) that is defined inside
the program file. The reason for this is that parsing the
"implementation" section of a unit (which is mostly the same feature
as parsing the inside of a program) is just not implemented in pasdoc.
We want to have this feature, but so far simply noone implemented it
-- see http://pasdoc.sipsolutions.net/WantedFeaturesParsingImplementation
.

Patches / pull requests are most welcome for this!

Until it's implemented, the only solution is to put everything you
want to have documented in some unit's interface.

Best regards,
Michalis