RE: [Lxr-developer] Doco template

[Sethna, Z. (R. Brisbane) <ZS...@rs...>]

From what I have read about POD so far, it doesn't have any support for OO
constructs, unlike doxygen but then doxygen doesn't support perl yet :-{{

We can though manually 'add' the missing base class documentation. Their
should be no need to add 'empty' functions since POD (AFAIK) is pretty brain
dead and doesn't actually parse the perl code in anyway except to look for
POD commands (between lines beginning with '=pod' and '=cut').

Zubin


-----Original Message-----
From: Malcolm Box [mailto:ma...@br...]
Sent: Thursday, 21 June 2001 1:02 AM
To: lxr...@li...
Subject: Re: [Lxr-developer] Doco template


Hi Zubin,

"Sethna, Zubin (RSA, Brisbane)" wrote:
> I want to propose that we us the following file header and function
template
> (in perl's POD format) to document the LXR source code. Tried to keep it
> simple as possible.
<snip>

This looks good and simple which is always an advantage.  Being an OO
system there are lots of classes in the lxr - do you have a suggestion
for documenting them?  I don't know what the Perl Way is for this.

For example, what I'd really like to do (actually see done :-) is
documentation for each of the "base" classes Index, File & Lang to
define what the methods are and what the usage/expected return values
are.  At the moment it's only possible to deduce this by looking at one
of the derived classes, which risks confusing the interface and the
implementation.  I was considering adding empty functions to the base
classes as placeholders for derived code & possibly as a place for the
documentation.

Cheers,

Malcolm

_______________________________________________
Lxr-developer mailing list
Lxr...@li...
http://lists.sourceforge.net/lists/listinfo/lxr-developer