Home »
Public Forums »
archive »
perl script to create html documentation from source files available
| perl script to create html documentation from source files available [message #36732] |
Tue, 21 October 2003 01:11 |
justspam03
Messages: 36
Registered: October 2003
|
Member |
|
|
Hi,
yes - I have exactly what you are looking for. I wrote a perl script
'webdoc' that extracts information from comment blocks which look something
like this:
;+--------------------------------
; Function: mrdata::define
; Args : int nslices : number of slices
; int nshots : number of shots in the image series
; Calls : somefunction
; someotherfunction
; Desc : the program does this and that
;----------------------------------
;. this is an inline comment which will be added to the docu
The program then creates:
- one html file per source file
- optional call trees in html, based on the info in the 'calls' section
- one html file listing all files
- one html file listing all functions
- one central html file
Some features of the program:
- 'start' and 'end' of comment block markers and inline comment markers
are freely configurable which makes the program suitable for many
languages (e.g. perl, shell, etc.)
- freely definable keywords and their translation into html
('desc' will come up as 'Description' on the webpage
- freely definable layout of the HTML output files in which the
generated information will be imbedded
- any known function name in the html output is replaced
by a hyperlink to the documentation of this function, i.e.
the pages are all interlinked
- use of css style sheets which allows you to define your own
page look without interfering with the program
- direct access to your source code via the generated HTML pages
using a small perl viewer script - the viewer script even knows
a very little bit of syntax highlighting although I haven't
put much effort in this part, yet.
It's not entirely easy to configure, but I provide full documentation
via an extensive manpage and a little template project which should
be a good starting point. I've been running the program for some
years now and it should be pretty stable in the meantime.
I cannot put it up on the net for free download, but I'll be happy
to send the whole package to anybody who's interested. Please
send a mail to
oliver dot thilmann
at web dot de
Cheers
Oliver
|
|
|
|
Current Time: Wed Oct 08 19:15:18 PDT 2025
Total time taken to generate the page: 0.00568 seconds
comp.lang.idl-pvwave archive
Members
Search
Help
Login
Home
