diff options
author | 2020-05-01 10:49:28 +0200 | |
---|---|---|
committer | 2020-05-01 10:49:28 +0200 | |
commit | e30ab9be9af8dad2d15e0e8ddd36150768e29fd4 (patch) | |
tree | f1bb5bb6b3d3e34953999da4d568e7f0160066d6 /src | |
parent | 0120d1d8ff136a49f7ee78fc2f2f1dc9560ce737 (diff) |
netlist: Fix inclusion of examples in documentation. (nw)
Diffstat (limited to 'src')
-rw-r--r-- | src/lib/netlist/build/doxygen.conf | 6 | ||||
-rw-r--r-- | src/lib/netlist/examples/ne566.cpp | 10 | ||||
-rw-r--r-- | src/lib/netlist/macro/nlm_other.cpp | 2 |
3 files changed, 14 insertions, 4 deletions
diff --git a/src/lib/netlist/build/doxygen.conf b/src/lib/netlist/build/doxygen.conf index 6c592f3fdae..110a41acf43 100644 --- a/src/lib/netlist/build/doxygen.conf +++ b/src/lib/netlist/build/doxygen.conf @@ -771,7 +771,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = .. ../analog ../documentation ../devices ../macro +INPUT = .. ../analog ../documentation ../devices ../macro # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -844,7 +844,7 @@ EXCLUDE_SYMBOLS = # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = ../../../../nl_examples ../documentation +EXAMPLE_PATH = ../documentation ../examples # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and @@ -2019,7 +2019,7 @@ SEARCH_INCLUDES = YES # preprocessor. # This tag requires that the tag SEARCH_INCLUDES is set to YES. -INCLUDE_PATH = .. ../.. +INCLUDE_PATH = .. ../.. # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the diff --git a/src/lib/netlist/examples/ne566.cpp b/src/lib/netlist/examples/ne566.cpp index c6ef3d0d4ca..0fac07d9f0d 100644 --- a/src/lib/netlist/examples/ne566.cpp +++ b/src/lib/netlist/examples/ne566.cpp @@ -1,3 +1,12 @@ +// license:GPL-2.0+ +// copyright-holders:Couriersud + +/* + * ne566.cpp + * + */ + +//! [ne566_example] #include "netlist/devices/net_lib.h" @@ -19,3 +28,4 @@ NETLIST_START(oscillator) NET_C(GND, X.1, C1.2) NET_C(C1.1, X.7) NETLIST_END() +//! [ne566_example] diff --git a/src/lib/netlist/macro/nlm_other.cpp b/src/lib/netlist/macro/nlm_other.cpp index 5926d12d454..2a2478341ad 100644 --- a/src/lib/netlist/macro/nlm_other.cpp +++ b/src/lib/netlist/macro/nlm_other.cpp @@ -77,10 +77,10 @@ NETLIST_END() //- This implementation is focused on performance. There may be edge cases //- which lead to issues and ringing. //. +//- Example: ne566.cpp,ne566_example //- FunctionTable: //- https://www.egr.msu.edu/eceshop/Parts_Inventory/datasheets/lm566.pdf //- -//- Example: ne566.cpp,ne566_example //. static NETLIST_START(NE566_DIP) |