<div dir="ltr">There is of course already <a href="https://github.com/erlang/otp/blob/maint/lib/edoc/priv/edoc.dtd">https://github.com/erlang/otp/blob/maint/lib/edoc/priv/edoc.dtd</a>, but it might need updating.<br></div><div class="gmail_extra"><br clear="all"><div><div class="gmail_signature" data-smartmail="gmail_signature"><br>        /Richard</div></div>
<br><div class="gmail_quote">2016-10-03 22:31 GMT+02:00 Vlad Dumitrescu <span dir="ltr"><<a href="mailto:vladdu55@gmail.com" target="_blank">vladdu55@gmail.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Hi,<div><br></div><div>If we are to be able to provide an API to locate and extract documentation for code constructs, what would be a good format to return it in? The source can be code comments or external files, which means that there will be multiple possible source formats (edoc, xml, asciidoc, rst, markdown, etc). </div><div><br></div><div>I can see the following alternatives:</div><div>* raw: textual data as in the source, the clients have to parse and interpret it</div><div>* display: textual data that can be rendered (basically, HTML)</div><div>* structured: some data structure that unifies the different sources; some kind of plug-ins providing parser support are needed.</div><div><br></div><div>The 'raw' solution will be needed by the other two to retrieve the doc sources, but are the others useful to have in the library? I would like to be able to provide the 'structured' format.</div><div><br></div><div>This is the kind of API I am looking at: <a href="https://gist.github.com/vladdu/aa571a548cecfeb85b84c65378429bf0" target="_blank">https://gist.github.com/<wbr>vladdu/<wbr>aa571a548cecfeb85b84c65378429b<wbr>f0</a> (thanks Joe for pointing me in this direction!). There should also be a way to configure the location of the external docs.</div><div><br></div><div>best regards,<br></div><div>Vlad</div><div><br></div></div>
<br>______________________________<wbr>_________________<br>
erlang-questions mailing list<br>
<a href="mailto:erlang-questions@erlang.org">erlang-questions@erlang.org</a><br>
<a href="http://erlang.org/mailman/listinfo/erlang-questions" rel="noreferrer" target="_blank">http://erlang.org/mailman/<wbr>listinfo/erlang-questions</a><br>
<br></blockquote></div><br></div>