From 241527a3cb287c1033b3a71a7cc14c40f22ec607 Mon Sep 17 00:00:00 2001
From: Sayed Adel <seiko@imavr.com>
Date: Tue, 31 Aug 2021 20:16:05 +0200
Subject: DOC: Improve Doxygen Javadoc style examples

---
 doc/source/dev/examples/doxy_class.hpp | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 doc/source/dev/examples/doxy_class.hpp

(limited to 'doc/source/dev/examples/doxy_class.hpp')

diff --git a/doc/source/dev/examples/doxy_class.hpp b/doc/source/dev/examples/doxy_class.hpp
new file mode 100644
index 000000000..ceba63487
--- /dev/null
+++ b/doc/source/dev/examples/doxy_class.hpp
@@ -0,0 +1,21 @@
+/**
+ *  Template to represent limbo numbers.
+ *
+ *  Specializations for integer types that are part of nowhere.
+ *  It doesn't support with any real types.
+ *
+ *  @param Tp Type of the integer. Required to be an integer type.
+ *  @param N  Number of elements.
+*/
+template<typename Tp, std::size_t N>
+class DoxyLimbo {
+ public:
+    /// Default constructor. Initialize nothing.
+    DoxyLimbo();
+    /// Set Default behavior for copy the limbo.
+    DoxyLimbo(const DoxyLimbo<Tp, N> &l);
+    /// Returns the raw data for the limbo.
+    const Tp *data();
+ protected:
+    Tp p_data[N]; ///< Example for inline comment.
+};
-- 
cgit v1.2.1