diff options
| author | eb <eb@221aa14e-8319-0410-a670-987f0aec2ac5> | 2009-05-14 18:29:26 +0000 |
|---|---|---|
| committer | eb <eb@221aa14e-8319-0410-a670-987f0aec2ac5> | 2009-05-14 18:29:26 +0000 |
| commit | 349331a884594a9e242231bffb03112b8943883c (patch) | |
| tree | 9d765ce9484f84eeb95e74facb1c522dd1ff90e2 /docs/doxygen/other/shared_ptr_docstub.h | |
| parent | 18f685853b2bf1914148cb07a9c6df76f5063ff3 (diff) | |
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 'docs/doxygen/other/shared_ptr_docstub.h')
| -rwxr-xr-x | docs/doxygen/other/shared_ptr_docstub.h | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/doxygen/other/shared_ptr_docstub.h b/docs/doxygen/other/shared_ptr_docstub.h new file mode 100755 index 0000000000..428dd03f1a --- /dev/null +++ b/docs/doxygen/other/shared_ptr_docstub.h @@ -0,0 +1,24 @@ +namespace boost +{ + /*! + * \brief shared_ptr documentation stub + * + * \warning + * This isn't the real shared_ptr template. It's just enough to get doxygen + * to draw pretty collaboration diagrams. + * + * An enhanced relative of scoped_ptr with reference counted copy semantics. + * The object pointed to is deleted when the last shared_ptr pointing to it + * is destroyed or reset. + */ + +template<class T> class shared_ptr +{ +public: + + T * px; // contained pointer + +}; // shared_ptr + + +} // namespace boost |