Features
From Docu Wiki
For admins:
For users:
- Usage instructions
- Text formatting
- Javadoc tag support
- Programming language support
- Output engine support
For developers:
Pelzini is quite different from any other code documenter. It saves its documentation in a database, allowing more advanced analysis, and other nifty features such as search. Pelzini has a modular design allowing for support for multiple programming languages, and multiple output systems.
Multiple programming lanuguages
Pelzini supports multiple programming languages, including:
Many more programming languages are planned to be supported in upcoming releases, including Python, Ruby, Perl, C++, and many others.
Documentation stored in a database
Pelzini stores its documentation in a database. Three different databases are supported:
Additional output systems are planned, including static HTML, DocBook, LaTeX, and many others.
Search
Pelzini supports documentation search, including code search. Searching can be restricted to various types of documentaion (such as functions or classes), or can search all elements.
Pelzini also has reports of various other useful things, such as a class tree, list of authors (using the @author tag) and a list of tables (using the @table tag). There is also a useful tool which lists documentation that doesn't match specified standards - such as a requirement for @author tags on all documentation, or the requirement of a summary for all functions, classes, etc.
Other features
- Support for many javadoc tags, including tags not seen in other documentation systems.
- Docblock tag cascading.
- Available in multiple languages.
For more information, see programming language support, JavaDoc tag support and database support
Many additional features are planned. For more information, see the roadmap.
