Inline documentation
Categories
Component ID
Component name
Component type
Maintenance status
Development status
Component security advisory coverage
Downloads
Component created
Component changed
Component body
Provide documentation at the places where you need it. Inline documentation does exactly what is says: show documentation on the pages and elements in the form of popup boxes.
Documentation is the key for easy maintenance or project transferring. However, no one likes to write documentation and no one likes to read documentation.
Inline documentation tries to ease the load of writing documentation simply by allowing the user to add short bits of documentation directly to the webpage where the reader needs it. This decreases the need for extensive Wiki pages and Word documents.
Navigate to the page in question, click the 'Add documentation' button and start writing some docs. It's recommended to keep these docs short and simple, you can add as many as you like to a page and you can even attach them to DOM elements.
