diff options
Diffstat (limited to 'src/lib/netlist/documentation/structure.dox.h')
-rw-r--r-- | src/lib/netlist/documentation/structure.dox.h | 47 |
1 files changed, 37 insertions, 10 deletions
diff --git a/src/lib/netlist/documentation/structure.dox.h b/src/lib/netlist/documentation/structure.dox.h index 41dd9507717..9d49656e161 100644 --- a/src/lib/netlist/documentation/structure.dox.h +++ b/src/lib/netlist/documentation/structure.dox.h @@ -1,20 +1,47 @@ -/*! 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 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. namespace detail { } |