[Lxr-developer] Doco template
Brought to you by:
ajlittoz
|
From: Sethna, Z. (R. Brisbane) <ZS...@rs...> - 2001-06-20 06:00:47
|
HI
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.
# File Header
=pod
=head2 SYNOPSIS
Purpose of functions in this file
=head2 FUNCTIONS
=cut
# End File Header
# Function Header
=pod
=head3 function name
Desciption of function
=cut
#End Function Header
html documentation can then be generated by doing:
pod2html pod2html --title="LXR Source - genxref" --infile=filename
--outfile=filename.html --header
I'll write a perl script to call this command for each perl file.
Have a look at http://www.zeta.org.au/~nbsethna/genxref.html to see an
(empty) example of the html output.
II'll be away next week so I won't be able to reply to any email till the
following week, after which I shall be producing html pages earnestly ;-)
Cheers
Zubin
|