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 /mblock/src/include | |
| 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 'mblock/src/include')
| -rw-r--r-- | mblock/src/include/mblock/mblock.h | 2 | ||||
| -rw-r--r-- | mblock/src/include/mblock/port.h | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/mblock/src/include/mblock/mblock.h b/mblock/src/include/mblock/mblock.h index 14517ffcc..bbc40f1ef 100644 --- a/mblock/src/include/mblock/mblock.h +++ b/mblock/src/include/mblock/mblock.h @@ -307,7 +307,7 @@ public: walk_tree(mb_visitor *visitor); - //! \implementation + //! \internal // internal use only mb_mblock_impl_sptr impl() const { return d_impl; } diff --git a/mblock/src/include/mblock/port.h b/mblock/src/include/mblock/port.h index 892a1dd97..782bb1285 100644 --- a/mblock/src/include/mblock/port.h +++ b/mblock/src/include/mblock/port.h @@ -85,7 +85,7 @@ public: /* * \brief Invalidate any cached peer resolutions - * \implementation + * \internal */ virtual void invalidate_cache() = 0; }; |