summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/documentation
diff options
context:
space:
mode:
author couriersud <couriersud@gmx.org>2019-11-07 20:25:51 +0100
committer couriersud <couriersud@gmx.org>2019-11-07 20:25:51 +0100
commitae2cad64f4744b13a9e776c087da227dc13d9104 (patch)
tree28e267579b6f2f420acb19e6e717e02ac7f185cb /src/lib/netlist/documentation
parent8564977f3ba67940416ac1dcb8134ec89c8df86f (diff)
netlist: code and documentation maintenance fixes. [Couriersud]
- "nltool -c docheader" now scans sources and creates usage focussed doxy documentation for devices. Very early stage, but works. For an example, please see ne555 source. - Started migrating to pure C++, i.e. "//" comments. - Various documentation fixes. - Added cppcheck configuration to netlist/build - Some smaller code changes.
Diffstat (limited to 'src/lib/netlist/documentation')
-rw-r--r--src/lib/netlist/documentation/primer_1.dox.h4
-rw-r--r--src/lib/netlist/documentation/structure.dox.h34
2 files changed, 26 insertions, 12 deletions
diff --git a/src/lib/netlist/documentation/primer_1.dox.h b/src/lib/netlist/documentation/primer_1.dox.h
index 8df612e242d..33f0bf64759 100644
--- a/src/lib/netlist/documentation/primer_1.dox.h
+++ b/src/lib/netlist/documentation/primer_1.dox.h
@@ -1,6 +1,6 @@
/*! \page primer_1 nltool primer
-## First example
+# First example
Let's start with a simple charge/discharge circuit. I denotes the input,
O denotes the output.
@@ -53,7 +53,7 @@ Next, run
and enjoy the results.
-##Recap
+# Recap
We have created our first netlist fragment. nltool was used to model the
periodically forced charge/discharge circuit for 50ms. Finally we plotted both input
diff --git a/src/lib/netlist/documentation/structure.dox.h b/src/lib/netlist/documentation/structure.dox.h
index 41dd9507717..d284208a51b 100644
--- a/src/lib/netlist/documentation/structure.dox.h
+++ b/src/lib/netlist/documentation/structure.dox.h
@@ -1,20 +1,34 @@
-/*! The netlist namespace.
- * All netlist related code is contained in the netlist namespace
- */
+///
+/// \defgroup compiledefine Compilation defines
+///
+/// Compilation defines can be specified using -DDEFINE=VALUE during compilation.
+/// If this is not done, a default is set, e.g.
+/// \code
+/// #ifndef DEFINE
+/// #define DEFINE (0)
+/// #endif
+/// \endcode
+///
+/// The define statements below thus show the default value.
+///
+///@{
+///@}
+
+/// \brief The netlist namespace.
+/// All netlist related code is contained in the netlist namespace
+
namespace netlist
{
- /*! The netlist::devices namespace.
- * All netlist devices are contained in the netlist::devices namespace.
- */
+ /// \brief The netlist::devices namespace.
+ /// All netlist devices are contained in the netlist::devices namespace.
namespace devices
{
}
- /*! Internal support classes you should not use in code using netlist api.
- * This namespace contains all internal support classes not intended
- * to be used outside of the core.
- */
+ /// \brief Internal support classes you should not use in code using netlist api.
+ /// This namespace contains all internal support classes not intended
+ /// to be used outside of the core.
namespace detail
{
}