Feature #433
Create a doc directory for the components already moved to the new structure
| Status: | Closed | Start date: | 09/22/2011 | |
|---|---|---|---|---|
| Priority: | Normal | Due date: | ||
| Assignee: | Tom Rondeau | % Done: | 0% |
|
| Category: | docs | |||
| Target version: | release-3.5 | |||
| Resolution: | fixed |
Description
In an on-going effort to improve the documentation, we need to add a doc directory to each component. This should contain a basic description of the component and be a part of the Doxygen output.
History
Updated by Tom Rondeau over 1 year ago
- Status changed from New to Closed
- Resolution set to fixed
The following components now have a doc directory:
- gr-audio
- gr-digital
- gr-qtgui
- gr-uhd
- gr-vocoder
The gr-noaa and gr-pager directories should be updated, but we can wait on those application-oriented components
The doc directories all have a bare-minimum README file and a more complete (but that could still use work) [component].dox file that acts as a page in the Doxygen manual for an explanation of the component. These are now linked from the main_page.dox that is the manual's main page.
As of commit:
06860c309153890a6a42babfbedf230eb24f0042