diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2011-11-27 20:27:35 -0500 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2011-11-27 20:27:35 -0500 |
| commit | c04d53d32513a48187aa51efc9e99e9a140a2689 (patch) | |
| tree | 4a4e1e25ae9b2be5d65c9396e654d699ed90c7b8 /gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h | |
| parent | 355dbf5b35e2c4ebbce6c5d7d1ef5a3b0f5610ce (diff) | |
docs: added doxygen and swig docs building tools into howto (cmake version only).
Diffstat (limited to 'gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h')
| -rw-r--r-- | gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h new file mode 100644 index 0000000000..7b8f29c988 --- /dev/null +++ b/gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h @@ -0,0 +1,44 @@ +/* -*- c++ -*- */ +/* + * Copyright 2010 Free Software Foundation, Inc. + * + * This file is part of GNU Radio + * + * GNU Radio is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3, or (at your option) + * any later version. + * + * GNU Radio is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GNU Radio; see the file COPYING. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, + * Boston, MA 02110-1301, USA. + */ +#include <iostream> + +/*! + * \brief Models the mammal Aadvark. + * + * Sadly the model is incomplete and cannot capture all aspects of an aadvark yet. + * + * This line is uninformative and is only to test line breaks in the comments. + */ +class Aadvark { +public: + //! \brief Outputs the vital aadvark statistics. + void print(); + //! \param aaness The aadvarkness of an aadvark is a measure of how aadvarky it is. + Aadvark(int aaness); + int get_aadvarkness(); +private: + int aadvarkness; +}; + +bool aadvarky_enough(Aadvark aad); + +int main(); |