[asterisk-dev] XML documentation of apps/functions/the_rest_of_the_world

Tzafrir Cohen tzafrir.cohen at xorcom.com
Wed Jul 9 02:14:40 CDT 2008


Is it simple to write documentation?

How can I refer to other parts of the documentation in a specific
document? e.g.: (let me dream for a minute) "for other parameters of this 
application, see doc:apps/app_dial#options").

Refering to "something in the middle of a docuemnt" is actually more of
an HTML-like implementation detail. Refering to an arbitrary "label" is
something that could be of great use. I consider this a major
requirement. Otherwise we'll have to waste much space later on on

We already have a generated "Asterisk book". Can module documentation 
refer to specific labels in it? How can it be integrated into it?

(In my suggestion: module documentation is asciidoc, and may generate
latex and/or docbook for integration with the rest of the documentation)

               Tzafrir Cohen
icq#16849755              jabber:tzafrir.cohen at xorcom.com
+972-50-7952406           mailto:tzafrir.cohen at xorcom.com
http://www.xorcom.com  iax:guest at local.xorcom.com/tzafrir

More information about the asterisk-dev mailing list