[OpenSER-Docs] Add examples in module documentation

Stefan Sayer stefan.sayer at iptego.com
Wed Feb 27 13:40:59 CET 2008


Iñaki Baz Castillo wrote:
> Hi, for now they are just a few modules that include real examples in their 
> doc. Usually, a module doc just shows examples of how to set each parameter 
> or use each function, but there is not a "global" example.
> I don't know if would be good to include a section "Examples" in the module 
> doc template (it could saturate the info), or maybe a section "Examples" 
> containing links to the wiki or external references.
> What do you think about it?
I think this would be the most important task for the documentation, to 
add real-life example config how the functionality is used.


Stefan Sayer
VoIP Services

stefan.sayer at iptego.com

iptego GmbH
Am Borsigturm 40
13507 Berlin

Amtsgericht Charlottenburg, HRB 101010
Geschaeftsfuehrer: Alexander Hoffmann

More information about the sr-docs mailing list