SNMP-Classes
Bla bla bla. This is my purpose
Walter Werther
{@link mailto:walter@wwerther.de walter@wwerther.de}
{@toc}
SNMP-Basics
This is my first paragraph
SNMP-Connectors
About connectors
Real-Connector
This is my first paragraph
This is my second paragraph
An end-user generally wants:
Instruction-style writing, that explains and describes general concepts more than how a particular variable is used
Interface information only, no low-level details
Examples of how to use, and tutorials
Whereas a programmer may want in addition:
Details on how program elements interact, which elements use others
Where in the source code an action or series of actions occurs
How to extend the code to add new functionality
This is my last paragraph
Buffered-Connector
This is my first paragraph
This is my second paragraph
SNMP Tree
SNMP Table
SNMP Table-Entries
Exceptions
Tips on Revising
There are many ways of creating good documentation, but perhaps the best is to read what you have written from different perspectives. Open up your documentation, and try to use it to figure out your software project. If this is difficult, go back and edit or rewrite. Remove anything that is confusing or unnecessary, make sure everything is there that is needed, and then when it seems good, ask a php user that doesn't know your project, or even a non-programmer to read it and use their reactions to tailor the documentation.
Conclusion
The use of phpDocumentor will definitely improve the look and feel of your documentation, but don't stop there, let it help you to create truly dynamic documents that are easily maintained and kept up-to-date. After all, great docs for great programs will help to secure PHP's rightful throne as the best out there!
References for learning how to use phpDocumentor
{@tutorial phpDocumentor.quickstart.pkg}