Doc fixes. Merged eb/t367 -r11020:11025 to trunk. This changeset
authoreb <eb@221aa14e-8319-0410-a670-987f0aec2ac5>
Thu, 14 May 2009 18:29:26 +0000 (18:29 +0000)
committereb <eb@221aa14e-8319-0410-a670-987f0aec2ac5>
Thu, 14 May 2009 18:29:26 +0000 (18:29 +0000)
commit349331a884594a9e242231bffb03112b8943883c
tree9d765ce9484f84eeb95e74facb1c522dd1ff90e2
parent18f685853b2bf1914148cb07a9c6df76f5063ff3
Doc fixes.  Merged eb/t367 -r11020:11025 to trunk.  This changeset
moves the primary doxygen configuration under the top-level docs
directory.  It creates a new "docs" top-level component that can be
enabled/disabled using the configure --disable-docs option.  At this
time, the --enable-doxygen option is still required to enable the
generation of the doxygen documents.  I think the flag should probably
be removed, and default to "yes" if we find doxygen on the path.  The
user can disable the doc generation using --disable-docs if desired.

The doxygen config file has been modified such that doxygen is now
only run on the C++ sources.  No attempt is made to process the python
code using doxygen.  This results in a less confusing set of docs for
the the C++ API.  Straightening out the python docs is left for later.

Many classes are currently misclassified (\ingroup <wrong>).  That
will probably require another day of work, that I can't get to right now.

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11027 221aa14e-8319-0410-a670-987f0aec2ac5
49 files changed:
config/Makefile.am
config/grc_docs.m4 [new file with mode: 0644]
config/grc_gnuradio_core.m4
configure.ac
docs/Makefile.am [new file with mode: 0644]
docs/doxygen/Doxyfile.in [new file with mode: 0644]
docs/doxygen/Makefile.am [new file with mode: 0644]
docs/doxygen/other/Makefile.am [new file with mode: 0644]
docs/doxygen/other/doxypy.py [new file with mode: 0755]
docs/doxygen/other/group_defs.dox [new file with mode: 0644]
docs/doxygen/other/main_page.dox [new file with mode: 0644]
docs/doxygen/other/omnithread.html [new file with mode: 0644]
docs/doxygen/other/omnithread.pdf [new file with mode: 0644]
docs/doxygen/other/omnithread.ps [new file with mode: 0644]
docs/doxygen/other/shared_ptr_docstub.h [new file with mode: 0755]
docs/doxygen/other/tv-channel-frequencies [new file with mode: 0644]
docs/doxygen/other/vector_docstub.h [new file with mode: 0644]
docs/doxygen/xml-swig/Makefile.am [new file with mode: 0644]
docs/doxygen/xml-swig/README [new file with mode: 0644]
docs/doxygen/xml-swig/doxy2swig.py [new file with mode: 0644]
docs/doxygen/xml-swig/swig.xsl [new file with mode: 0644]
gnuradio-core/Makefile.am
gnuradio-core/doc/Doxyfile.in [deleted file]
gnuradio-core/doc/Makefile.am [deleted file]
gnuradio-core/doc/other/Makefile.am [deleted file]
gnuradio-core/doc/other/doxypy.py [deleted file]
gnuradio-core/doc/other/group_defs.dox [deleted file]
gnuradio-core/doc/other/main_page.dox [deleted file]
gnuradio-core/doc/other/omnithread.html [deleted file]
gnuradio-core/doc/other/omnithread.pdf [deleted file]
gnuradio-core/doc/other/omnithread.ps [deleted file]
gnuradio-core/doc/other/shared_ptr_docstub.h [deleted file]
gnuradio-core/doc/other/tv-channel-frequencies [deleted file]
gnuradio-core/doc/other/vector_docstub.h [deleted file]
gnuradio-core/doc/xml-swig/Makefile.am [deleted file]
gnuradio-core/doc/xml-swig/README [deleted file]
gnuradio-core/doc/xml-swig/doxy2swig.py [deleted file]
gnuradio-core/doc/xml-swig/swig.xsl [deleted file]
gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
gr-audio-portaudio/src/audio_portaudio_sink.h
gr-audio-portaudio/src/audio_portaudio_source.h
mblock/src/include/mblock/mblock.h
mblock/src/include/mblock/port.h
mblock/src/lib/mb_mblock_impl.h
mblock/src/lib/mb_port_simple.h
mblock/src/lib/mb_runtime_base.h
mblock/src/lib/mb_runtime_thread_per_block.h
mblock/src/lib/mb_worker.h
pmt/src/lib/pmt.h