[asterisk-bugs] [Asterisk 0017184]: [patch] Updates to Application Documentation

[Asterisk Bug Tracker]

A NOTE has been added to this issue. 
====================================================================== 
https://issues.asterisk.org/view.php?id=17184 
====================================================================== 
Reported By:                chappell
Assigned To:                
====================================================================== 
Project:                    Asterisk
Issue ID:                   17184
Category:                   Documentation
Reproducibility:            always
Severity:                   text
Priority:                   normal
Status:                     ready for testing
Asterisk Version:           SVN 
JIRA:                        
Regression:                 No 
Reviewboard Link:            
SVN Branch (only for SVN checkouts, not tarball releases): N/A 
SVN Revision (number only!):  
Request Review:              
====================================================================== 
Date Submitted:             2010-04-14 11:52 CDT
Last Modified:              2010-04-16 08:35 CDT
====================================================================== 
Summary:                    [patch] Updates to Application Documentation
Description: 
Everybody knows that programmers would rather code than write
documentation.  As a result, much of the documentation for Asterisk
applications, functions, etc., is either skeletal or written from the
perspective of an Asterisk programmer rather than that of a dialplan
author.

This patch attempts to rewrite the documentation for the core applications
in order to make it more precise and informative.
====================================================================== 

---------------------------------------------------------------------- 
 (0120535) chappell (reporter) - 2010-04-16 08:35
 https://issues.asterisk.org/view.php?id=17184#c120535 
---------------------------------------------------------------------- 
I have uploaded new patches against 1.6.2.1 and against trunk.  Unlike the
first patch, this one has valid XML which will load into Asterisk.

If you are using 1.6.1.X, there is no harm in trying to apply the patch
for 1.6.2.1.  It patches a single file, main/pbx.c and it only patches
comments.  Just save a copy of main/pbx.c in case it doesn't work.

In reply to lmadsen: Thanks for the hint. The actual command is "make
validate-docs".  I have looked at the code that loads the documentation. 
The load function is called during Asterisk startup.  There does not appear
to be a way to reload the documentation.  I wonder why the documentation is
loaded into RAM.  Couldn't we just load the needed piece from the files
when called for?  Just something to think about. 

Issue History 
Date Modified    Username       Field                    Change               
====================================================================== 
2010-04-16 08:35 chappell       Note Added: 0120535                          
======================================================================