[SR-Docs] pua module documentation doesn't reflect the current module api

Daniel-Constantin Mierla miconda at gmail.com
Wed Aug 18 17:18:54 CEST 2010


On 8/17/10 10:43 PM, nikita kozlov wrote:
> Hello,
> According to
> http://lists.sip-router.org/pipermail/sr-dev/2010-August/008445.html, I
> propose a patch for pua module documentation.
> It could be quite annoying to start a new module using pua api and
> realize that the api mismatch the documentation. Especially if your
> first reflex was to write a patch for the current code and implement the
> old api ;-).
unfortunately the devel APIs were left behind in the modules docbook 
documentation. There are many modules exporting API, not documented at 
all, the READMEs being mainly updated with config parameters and functions.

There is also ongoing effort to get doxygen style documentation directly 
in the sources. I think the best is to have both, but not many 
volunteers around.

I will apply your patch, if you have further improvements to 
documentation, please send over. I can even easy your way to add 
documentation updates by yourself.


Daniel-Constantin Mierla

More information about the sr-docs mailing list