Documentation Upgrade Working Group

The purpose of this group is to address issues related to documenting blocks in a manner which uses source code of the blocks as the basis of all related documents.

Examine current process of generating the doxygen manual
The GNU Radio Manual and C++ API Reference document currently does not reflect the current release version.

Some notes from #Docs chat
The "C++ API and Users Guide" will be a combination of programatically generated API docs and user-oriented information. The "C++ API and Users Guide" will contain: Summary description of the block Block parameters Port information Any relevant theoretical background on the block ** Example flowgraphs ** Block API documentation The wiki block docs will contain: Summary + Block parameters + Technical details Example flowgraphs Link to API docs


 * ** - From wiki
 * + - From code

Road map for group
What are the plans to move forward?

1. Create a list of all blocks from source code. 2. Create procedures, scripts, etc. to render the "C++ API and Users Guide" 3. Create bots to scan for changes in the source code. 4. Provide links to support editing the Wiki.