[asterisk-dev] Source Documentation

[Jason Parker]

----- Erik Sundberg <erik.sundberg at sipbox.net> wrote:
> Hello All,
> 
> Is there a utility to pull the documentation out of the source
> code????
> 
> I noticed that the header files have the following /*! for source
> code
> documentation.
> 
> 
> EXAMPLE: 
> char *ast_state2str(int state);
> 
> /*! Gives the string form of a given transfer capability */
> /*!
>  * \param transfercapability transfercapabilty to get the name of
>  * Give a name to a transfercapbility
>  * See above
>  * Returns the text form of the binary transfer capbility
>  */
> 
> 
> 
> Erik Sundberg
> SIPBox, Inc.
> 18400 South 76th Ave. Suite D
> Tinley Park, IL 60477
>   
> Phone: 888-SIP-BOX1 (888-747-2691) 
> Extension: 4808
> Direct: 708-468-4808
> Fax: 708-570-0350
> Hours: 9AM-5PM CST Monday - Friday
> Email: erik.sundberg at sipbox.net
> Website: www.sipbox.net

After you run `make install`, it explains that you can run `make progdocs` to get the asterisk program documentation

-- 
Jason Parker
Digium