From c04d53d32513a48187aa51efc9e99e9a140a2689 Mon Sep 17 00:00:00 2001
From: Tom Rondeau <trondeau@vt.edu>
Date: Sun, 27 Nov 2011 20:27:35 -0500
Subject: docs: added doxygen and swig docs building tools into howto (cmake
version only).
---
.../docs/doxygen/doxyxml/example/aadvark.h | 44 ++++++++++++++++++++++
1 file changed, 44 insertions(+)
create mode 100644 gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h
(limited to 'gr-howto-write-a-block-cmake/docs/doxygen/doxyxml/example/aadvark.h')
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();
--
cgit v1.2.3