diff options
| author | eb | 2009-05-14 18:29:26 +0000 |
|---|---|---|
| committer | eb | 2009-05-14 18:29:26 +0000 |
| commit | 349331a884594a9e242231bffb03112b8943883c (patch) | |
| tree | 9d765ce9484f84eeb95e74facb1c522dd1ff90e2 /config/grc_docs.m4 | |
| parent | 18f685853b2bf1914148cb07a9c6df76f5063ff3 (diff) | |
| download | gnuradio-349331a884594a9e242231bffb03112b8943883c.tar.gz gnuradio-349331a884594a9e242231bffb03112b8943883c.tar.bz2 gnuradio-349331a884594a9e242231bffb03112b8943883c.zip | |
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
Diffstat (limited to 'config/grc_docs.m4')
| -rw-r--r-- | config/grc_docs.m4 | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/config/grc_docs.m4 b/config/grc_docs.m4 new file mode 100644 index 000000000..86b31ae02 --- /dev/null +++ b/config/grc_docs.m4 @@ -0,0 +1,33 @@ +dnl Copyright 2009 Free Software Foundation, Inc. +dnl +dnl This file is part of GNU Radio +dnl +dnl GNU Radio is free software; you can redistribute it and/or modify +dnl it under the terms of the GNU General Public License as published by +dnl the Free Software Foundation; either version 3, or (at your option) +dnl any later version. +dnl +dnl GNU Radio is distributed in the hope that it will be useful, +dnl but WITHOUT ANY WARRANTY; without even the implied warranty of +dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +dnl GNU General Public License for more details. +dnl +dnl You should have received a copy of the GNU General Public License +dnl along with GNU Radio; see the file COPYING. If not, write to +dnl the Free Software Foundation, Inc., 51 Franklin Street, +dnl Boston, MA 02110-1301, USA. + +AC_DEFUN([GRC_DOCS],[ + GRC_ENABLE(docs) + + AC_CONFIG_FILES([ \ + docs/Makefile \ + docs/doxygen/Doxyfile \ + docs/doxygen/Makefile \ + docs/doxygen/other/Makefile \ + docs/doxygen/xml-swig/Makefile \ + ]) + + GRC_BUILD_CONDITIONAL(docs) + +]) |