<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<p>Hello,</p>
<p>curious to see if it works with comments starting with #, because
it's the common across kamailio configs or it needs to convert
them to c-style alternatives ...</p>
<p>Cheers,<br>
Daniel<br>
</p>
<br>
<div class="moz-cite-prefix">On 20/10/16 11:49, José Seabra wrote:<br>
</div>
<blockquote
cite="mid:CAEVZRWvUmyH0Pp4EEREa4-xoo+SOvybu8fhRznv47UxecQSWFA@mail.gmail.com"
type="cite">
<div dir="ltr">
<div>
<div>
<div>
<div>
<div>Hi, Olle,<br>
</div>
Thank you for your reply.<br>
</div>
I will take your advice and try Doxygen :)<br>
<br>
</div>
Thank you all.<br>
</div>
BR<br>
</div>
José Seabra<br>
</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">2016-10-20 10:36 GMT+01:00 Olle E.
Johansson <span dir="ltr"><<a moz-do-not-send="true"
href="mailto:oej@edvina.net" target="_blank">oej@edvina.net</a>></span>:<br>
<blockquote class="gmail_quote" style="margin:0 0 0
.8ex;border-left:1px #ccc solid;padding-left:1ex">
<div style="word-wrap:break-word">I imagine that you could
use tools like Doxygen for this. Doxygen is something we
use in
<div>Kamailio to create developer docs - web pages that
explains variables, functions and</div>
<div>takes data from comments with a special syntax.</div>
<div><br>
</div>
<div>Here’s one example:</div>
<div><a moz-do-not-send="true"
href="http://rpm.kamailio.org/doxygen/sip-router/branch/master/index.html"
target="_blank">http://rpm.kamailio.org/<wbr>doxygen/sip-router/branch/<wbr>master/index.html</a></div>
<div><br>
</div>
<div>There are several similar tools, like jdoc and
perldoc.</div>
<span class="HOEnZb"><font color="#888888">
<div><br>
</div>
<div><br>
</div>
<div>/O</div>
</font></span>
<div>
<div class="h5">
<div><br>
<div>
<blockquote type="cite">
<div>On 20 Oct 2016, at 10:33, José Seabra <<a
moz-do-not-send="true"
href="mailto:joseseabra4@gmail.com"
target="_blank">joseseabra4@gmail.com</a>>
wrote:</div>
<br
class="m_5867890123429426814Apple-interchange-newline">
<div>
<div dir="ltr">
<div>
<div>
<div>
<div>Hello Daniel,<br>
</div>
Thank you for your reply,<br>
</div>
Can you advice one of these tools
please? i will try it :)<br>
<br>
</div>
BR<br>
</div>
José Seabra<br>
</div>
<div class="gmail_extra"><br>
<div class="gmail_quote">2016-10-20 10:18
GMT+01:00 Daniel-Constantin Mierla <span
dir="ltr"><<a moz-do-not-send="true"
href="mailto:miconda@gmail.com"
target="_blank">miconda@gmail.com</a>></span>:<br>
<blockquote class="gmail_quote"
style="margin:0 0 0 .8ex;border-left:1px
#ccc solid;padding-left:1ex">
<div bgcolor="#FFFFFF" text="#000000">
<p>Hello,</p>
<p>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:</p>
<p>//</p>
<p>and</p>
<p>/* */</p>
If anyone tries, would be great to
know the results.<br>
<p>Cheers,<br>
Daniel<br>
</p>
<div>
<div class="m_5867890123429426814h5">
<br>
<div
class="m_5867890123429426814m_-2328041072860983236moz-cite-prefix">On
18/10/16 11:22, José Seabra
wrote:<br>
</div>
</div>
</div>
<blockquote type="cite">
<div>
<div
class="m_5867890123429426814h5">
<div dir="ltr">
<div>
<div>Hello there,<br>
</div>
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?<br>
<br>
</div>
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.<br>
<br>
<div>
<div>
<div><br>
</div>
<div>Thank you<br>
</div>
<div>-- <br>
<div
class="m_5867890123429426814m_-2328041072860983236gmail_signature">
<div>Best Regards<br>
José Seabra</div>
</div>
</div>
</div>
</div>
</div>
<br>
<fieldset
class="m_5867890123429426814m_-2328041072860983236mimeAttachmentHeader"></fieldset>
<br>
</div>
</div>
<pre>______________________________<wbr>_________________
SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
<a moz-do-not-send="true" class="m_5867890123429426814m_-2328041072860983236moz-txt-link-abbreviated" href="mailto:sr-users@lists.sip-router.org" target="_blank">sr-users@lists.sip-router.org</a>
<a moz-do-not-send="true" class="m_5867890123429426814m_-2328041072860983236moz-txt-link-freetext" href="http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users" target="_blank">http://lists.sip-router.org/cg<wbr>i-bin/mailman/listinfo/sr-user<wbr>s</a><span class="m_5867890123429426814HOEnZb"><font color="#888888">
</font></span></pre><span class="m_5867890123429426814HOEnZb"><font color="#888888">
</font></span></blockquote><span class="m_5867890123429426814HOEnZb"><font color="#888888">
<pre class="m_5867890123429426814m_-2328041072860983236moz-signature" cols="72">--
Daniel-Constantin Mierla
<a moz-do-not-send="true" class="m_5867890123429426814m_-2328041072860983236moz-txt-link-freetext" href="http://twitter.com/#%21/miconda" target="_blank">http://twitter.com/#!/miconda</a> - <a moz-do-not-send="true" class="m_5867890123429426814m_-2328041072860983236moz-txt-link-freetext" href="http://www.linkedin.com/in/miconda" target="_blank">http://www.linkedin.com/in/mic<wbr>onda</a>
Kamailio Advanced Training, Berlin, Oct 24-26, 2016 - <a moz-do-not-send="true" class="m_5867890123429426814m_-2328041072860983236moz-txt-link-freetext" href="http://www.asipto.com/" target="_blank">http://www.asipto.com</a></pre>
</font></span></div>
______________________________<wbr>_________________
SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
<a moz-do-not-send="true" href="mailto:sr-users@lists.sip-router.org" target="_blank">sr-users@lists.sip-router.org</a>
<a moz-do-not-send="true" href="http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users" rel="noreferrer" target="_blank">http://lists.sip-router.org/cg<wbr>i-bin/mailman/listinfo/sr-user<wbr>s</a>
</blockquote></div>
--
<div class="m_5867890123429426814gmail_signature" data-smartmail="gmail_signature">Cumprimentos<div>José Seabra</div></div>
</div>
______________________________<wbr>_________________
SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
<a moz-do-not-send="true" href="mailto:sr-users@lists.sip-router.org" target="_blank">sr-users@lists.sip-router.org</a>
<a moz-do-not-send="true" href="http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users" target="_blank">http://lists.sip-router.org/<wbr>cgi-bin/mailman/listinfo/sr-<wbr>users</a>
</div></blockquote></div>
</div></div></div></div>
______________________________<wbr>_________________
SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
<a moz-do-not-send="true" href="mailto:sr-users@lists.sip-router.org">sr-users@lists.sip-router.org</a>
<a moz-do-not-send="true" href="http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users" rel="noreferrer" target="_blank">http://lists.sip-router.org/<wbr>cgi-bin/mailman/listinfo/sr-<wbr>users</a>
</blockquote></div>
--
<div class="gmail_signature" data-smartmail="gmail_signature">Cumprimentos<div>José Seabra</div></div>
</div>
<fieldset class="mimeAttachmentHeader"></fieldset>
<pre wrap="">_______________________________________________
SIP Express Router (SER) and Kamailio (OpenSER) - sr-users mailing list
<a class="moz-txt-link-abbreviated" href="mailto:sr-users@lists.sip-router.org">sr-users@lists.sip-router.org</a>
<a class="moz-txt-link-freetext" href="http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users">http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users</a>
</pre>
</blockquote>
<pre class="moz-signature" cols="72">--
Daniel-Constantin Mierla
<a class="moz-txt-link-freetext" href="http://twitter.com/#!/miconda">http://twitter.com/#!/miconda</a> - <a class="moz-txt-link-freetext" href="http://www.linkedin.com/in/miconda">http://www.linkedin.com/in/miconda</a>
Kamailio Advanced Training, Berlin, Oct 24-26, 2016 - <a class="moz-txt-link-freetext" href="http://www.asipto.com">http://www.asipto.com</a></pre></body></html>