[asterisk-dev] Asterisk XML documentation (appdocsxml branch) is ready
Russell Bryant
russell at digium.com
Mon Oct 20 11:06:44 CDT 2008
Tilghman Lesher wrote:
> On Sunday 19 October 2008 19:59:08 Vadim Lebedev wrote:
>> Maybe it's a dumb idea but I wonder,
>> if the same effect could be achieved by keeping Doxygen format doc and
>> using some XSLT processing
>> to transform whatever need to transformed to XML.
>
> Someone can correct me if I'm wrong, but I believe that the appdocsxml branch
> isn't meant to replace developer documentation at all, which will stay as
> Doxygen format, but rather to fixup the user-embedded documentation, such that
> multiple translations can coexist in the code.
>
Correct. In addition to translations, having it in a parseable format
will make it easier to take the same information and use it outside of
the code for the purpose of having higher quality, maintainable
user-oriented documentation.
--
Russell Bryant
Senior Software Engineer
Open Source Team Lead
Digium, Inc.
More information about the asterisk-dev
mailing list