EMBOSS: C2 Software Documentation
The source files have documentation in a format derived from JavaDoc
with extensions developed at the Sanger Centre for other
- There is a perl parser for the documentation comments in the
source files. This checks the parameters and return type against the
function definition and also reports errors if descriptions are missing.
The log file fromthis parser is checked regularly.
The output from the parser is an HTML page with the documentation
for all functions in one source file.
The same parser reads the include files and notes the documentation on
the data types.
There is still a need to check the HTML output and to find ways to
add new files automatically to the index pages.
The parser also writes an "EMBL" style flat file which is indexed by
SRS as EFUNC
on the Sanger Centre SRS 6.0 server.
The SRS indexed source code in EFUNC
is the easiest way to see the function documentation and sources and
to navigate to other functions. See, for example, ajStrAss
The SRS EDATA
index takes you from the data objects to the most important functions
that use them.
The parser needs to be cleaned up and made available in the "scripts"