Help, Documentation tools
Software Documentation is an important part of software engineering that isoften overlooked. Types of documentation include: * Architecture - Architectural overview of software; including relations to an environment, construction principles to be used in design and technical documentation, etc. * Design - The design of software components.* Technical - Documentation of code, algorithms, interfaces, APIs.* End User - Manuals for the end-user.* Operator - Manuals for the systems administrator.
From : en.wikipedia.org/wiki/Software_Documentation
DocWrench
DocWrench is a modern doclet for JavaDocâ?¢. Its result is similar to the API documentation generated by the standard doclet, however it makes the most of present DHTML format. It has the following features:
No frames
Package and class lists are imported into the main page, thus you can bookmark its URL.
Tabbed content
Content parts are grouped in a tabbed control to reduce scrolling. Class use page is also included.
Summary and detail merged
Drag the mouse over a field, constructor, or method summary to unfold the details including thrown exceptions, the description beside the first sentence, and tags. This reduces scrolling, and decreases the size of the HTML file (e.g.: Jakarta Commons Collections documentation is compressed to the third of its original size).
Index search
JavaScript is used to search the index in a text field instead of a large static page.
Exclude tag
Mark a package, class, interface, field, constructor, or method with @exclude tag and it'll be excluded from the generated documentation.
visit
DocWrench
DocWrench was visited : 54 times
Loading .....