[SR-Users] Kamailio script config - Generate Documentation

[Olle E. Johansson]

I imagine that you could use tools like Doxygen for this. Doxygen is something we use in
Kamailio to create developer docs - web pages that explains variables, functions and
takes data from comments with a special syntax.

Here’s one example:
http://rpm.kamailio.org/doxygen/sip-router/branch/master/index.html

There are several similar tools, like jdoc and perldoc.


/O

> On 20 Oct 2016, at 10:33, José Seabra <joseseabra4 at gmail.com> wrote:
> 
> Hello Daniel,
> Thank you for your reply,
> Can you advice one of these tools please? i will try it :)
> 
> BR
> José Seabra
> 
> 2016-10-20 10:18 GMT+01:00 Daniel-Constantin Mierla <miconda at gmail.com <mailto:miconda at gmail.com>>:
> Hello,
> 
> not aware of any such effort, but maybe tools that can be used to extract the documentation from a c code can be reused to some extent -- inside kamailio.cfg we support the c-style comments, both:
> 
> //
> 
> and
> 
> /*  */
> 
> If anyone tries, would be great to know the results.
> Cheers,
> Daniel
> 
> On 18/10/16 11:22, José Seabra wrote:
>> Hello there,
>> I'm sending this email in order to know if anyone had work or has any idea how we can generate Documentation from kamailio script using Comments?
>> 
>> This would be great because we could write comments explaining the Route method during  script development  and use it to generate documentation about our kamailio script, saving time and leave our deployment documented.
>> 
>> 
>> Thank you
>> --
>> Best Regards
>> José Seabra
>> 
>> 
>> _______________________________________________
>> SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
>> sr-users at lists.sip-router.org <mailto:sr-users at lists.sip-router.org>
>> http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users <http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users>
> 
> --
> Daniel-Constantin Mierla
> http://twitter.com/#!/miconda <http://twitter.com/#!/miconda> - http://www.linkedin.com/in/miconda <http://www.linkedin.com/in/miconda>
> Kamailio Advanced Training, Berlin, Oct 24-26, 2016 - http://www.asipto.com <http://www.asipto.com/>
> _______________________________________________
> SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
> sr-users at lists.sip-router.org <mailto:sr-users at lists.sip-router.org>
> http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users <http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users>
> 
> 
> 
> 
> --
> Cumprimentos
> José Seabra
> _______________________________________________
> SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
> sr-users at lists.sip-router.org
> http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sip-router.org/pipermail/sr-users/attachments/20161020/8e00038a/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 657 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://lists.sip-router.org/pipermail/sr-users/attachments/20161020/8e00038a/attachment.sig>