How to write "documentation"? (WAS: RE : [PEAR-DEV] RFC: Commentation- and Rati ng-System für PEAR-Websites)

> > > And in the long run > > > the comments can help that lazy developer to write some doc with his > > > class. > > In 99% of all cases this will not happen. EOD. > Martin we cannot force people to write documentation. Neither by political > nor by technical means. Also this will enable much more than alternative > documentation, like tips and tricks and quality feedback. I am +1 for a > comments addition. I will be able to write documentation for my package if I know how. Till this time I was not able to grasp clear and understandable way, how to do it or at least where to find information about this. I'm enough familiar with DocBook SGML and Doxygen-like tools, however I'm not sure if these knowledges are not disposable for such matter. I wrote these Doxygen-like marks (@param, @return, etc) into source code, however I do not know if this is considered as "documentation". If so, than AFAIK most from the PEAR packages have documentation already written. -- _/| Ondrej Jombik - nepto@php.net - http://www.nepto.sk - OJ812-RIPE <_ \ Platon SDG - open source software development - http://platon.sk `\| Nech operacia X na mnozine G tvori grupu, potom plati... rundu! '`