summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/documentation
diff options
context:
space:
mode:
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.