Reviews and Ratings
reSIProcate is extremely poorly documented. It doesn't have any significant documentation besides the code's internal documentation (Doxygen). And surprisingly even that documentation is … well … no documentation at all.
They just generate Doxygen HTML documentation from their codebase *without* Doxygen documentation blocks in the code. This means that it'll just show you the actual code of each method, call graphs and inheritance diagram.
*Not even a single line that describes what the class is supposed to do.*
To make matters worse, there's a ridiculous amount of classes. And class names that make zero sense ("AppDialog" or "ClientOutOfDialogReq" anyone?)
Absolutely unusable by those who are just beginning with SIP. A nightmare.
For example:
- Their wiki: http://www.resiprocate.org/Main_Page
- The Doxygen for DialogUsageManager: http://www.estacado.net/resip-dox/dum/annotated.html
Saying that many other projects are badly documented as well is no valid justification – in case you wanted to go down that path.
Lead by example. Qt currently leads with their documentation: http://doc.trolltech.com/4.5/index.html.
Please adopt their model.