summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/documentation
diff options
context:
space:
mode:
author couriersud <couriersud@gmx.org>2019-11-08 23:52:14 +0100
committer couriersud <couriersud@gmx.org>2019-11-08 23:52:14 +0100
commit88f702b416ba9eb930e6c1e932124d5f24b1a24c (patch)
tree955f3047b79156d7b2bbab55fcbd4fbc94661f1d /src/lib/netlist/documentation
parent731c4fe52073a7a7561bf04559e9f0b3b791388d (diff)
netlist: code maintenance and bug fixes. (nw)
- comment style migration continues. - Fixed a two bugs in the truthtable ignore inputs code - refactored the truthtable code a bit for better readability. - updated netlist specific gitignore.
Diffstat (limited to 'src/lib/netlist/documentation')
-rw-r--r--src/lib/netlist/documentation/mainpage.dox.h14
-rw-r--r--src/lib/netlist/documentation/structure.dox.h19
2 files changed, 22 insertions, 11 deletions
diff --git a/src/lib/netlist/documentation/mainpage.dox.h b/src/lib/netlist/documentation/mainpage.dox.h
index cfe098845ed..053271f64ae 100644
--- a/src/lib/netlist/documentation/mainpage.dox.h
+++ b/src/lib/netlist/documentation/mainpage.dox.h
@@ -1,12 +1,10 @@
-/*
- * Documentation settings
- */
-
-/*!
- *
- * \mainpage Netlist
-
+//
+// Documentation settings
+//
+///
+/// \mainpage Netlist
+///
##Netlist
diff --git a/src/lib/netlist/documentation/structure.dox.h b/src/lib/netlist/documentation/structure.dox.h
index d284208a51b..9d49656e161 100644
--- a/src/lib/netlist/documentation/structure.dox.h
+++ b/src/lib/netlist/documentation/structure.dox.h
@@ -12,12 +12,11 @@
///
/// 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
{
/// \brief The netlist::devices namespace.
@@ -26,6 +25,20 @@ namespace netlist
{
}
+ /// \brief The netlist::analog namespace.
+ /// Netlist analog devices and related code are contained in the
+ /// netlist::analog namespace.
+ namespace analog
+ {
+ }
+
+ /// \brief The netlist::solver namespace.
+ /// All linear equation solving code and related code is contained in the
+ /// netlist::solver namespace.
+ namespace solver
+ {
+ }
+
/// \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.