-
Notifications
You must be signed in to change notification settings - Fork 99
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial doxygen integration. Probably needs a bunch of work.
- Loading branch information
1 parent
19bc636
commit 7058888
Showing
4 changed files
with
61 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
|
||
# Developer documentation | ||
if(BUILD_DEVDOCS) | ||
find_package(Doxygen | ||
REQUIRED dot mscgen dia) | ||
|
||
set(DOXYGEN_LOOKUP_CACHE_SIZE 2) | ||
|
||
doxygen_add_docs(devdocs | ||
${PROJECT_SOURCE_DIR}/devdoc | ||
${PROJECT_SOURCE_DIR}/src/ngscopeclient | ||
${PROJECT_SOURCE_DIR}/lib/log | ||
${PROJECT_SOURCE_DIR}/lib/xptools | ||
${PROJECT_SOURCE_DIR}/lib/scopehal | ||
${PROJECT_SOURCE_DIR}/lib/scopeprotocols | ||
WORKING_DIRECTORY ${PROJECT_SOURCE_DIR} | ||
COMMENT "Generate developer documentation" | ||
) | ||
endif() | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
\mainpage | ||
|
||
# Introduction | ||
|
||
This is the developer documentation for ngscopeclient, libscopehal, and libscopeprotocols. If you plan to contribute to | ||
the project or write your own instrument drivers or filter graph blocks, this should be your primary reference | ||
material. | ||
|
||
End user documentation is located at (link here). | ||
|
||
\defgroup liblog Liblog (logging framework) | ||
|
||
\defgroup libscopehal Libscopehal (drivers and core base classes) | ||
|
||
\defgroup datamodel Waveform data model | ||
\ingroup libscopehal | ||
|
||
\defgroup drivers Instrument drivers | ||
\ingroup libscopehal | ||
|
||
\defgroup transports Transports (moves commands and data between drivers and physical hardware) | ||
\ingroup libscopehal | ||
|
||
\defgroup libscopeprotocols Libscopeprotocols (filter graph blocks) | ||
|
||
\defgroup ethernet Ethernet protocol decodes | ||
\ingroup libscopeprotocols | ||
|
||
\defgroup math Basic math functions | ||
\ingroup libscopeprotocols | ||
|
||
\defgroup ngscopeclient Ngscopeclient (GUI) | ||
|
||
\defgroup dialogs Dialog boxes | ||
\ingroup ngscopeclient |
Submodule lib
updated
7 files