summaryrefslogtreecommitdiffstatshomepage
path: root/src/lib/netlist/documentation/structure.dox.h
blob: 9d49656e161b7abed2c04195861a0c6a72dc7ca5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
///
/// \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
{
	/// \brief The netlist::devices namespace.
	/// All netlist devices are contained in the netlist::devices namespace.
	namespace devices
	{
	}

	/// \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
	{
	}
}