riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add meson build infrastructure for doxygen based content

This commit is contained in:
Rob Taylor 2023-11-17 19:56:57 +00:00 committed by Rob Taylor
parent e0969b8ca9
commit 6f3e6ca6d3
21 changed files with 3279 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitmodules vendored
View File

@ -4,3 +4,6 @@
url = https://github.com/Coloquinte/PlaceRoute.git
branch = main
update = merge
[submodule "documentation/pelican-plugins"]
path = documentation/pelican-plugins
url = https://github.com/getpelican/pelican-plugins

46
Seabreeze/doc/doxyfile → Seabreeze/doc/Doxyfile.in
View File

@ -48,7 +48,7 @@ PROJECT_NAME = "Seabreeze - Routing Toolbox"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.0
PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = @DOCBUILDDIR@
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@ -284,8 +284,8 @@ TAB_SIZE = 2
# @} or use a double escape (\\{ and \\})
ALIASES = "function=\fn" \
"important=\par Important:\n" \
"remark=\par Remark:\n" \
"important=\par Important:^^" \
"remark=\par Remark:^^" \
"sreturn=\b Returns:" \
"True=\b True" \
"true=\b true" \
@ -981,19 +981,19 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = Seabreeze.dox \
../src/Seabreeze/Node.h \
../src/Node.cpp \
Node.dox \
../src/Seabreeze/Tree.h \
../src/Tree.cpp \
Tree.dox \
../src/Seabreeze/Seabreeze.h \
../src/Seabreeze.cpp \
Seabreeze.dox \
../src/katabatic/SeabreezeEngine.h \
../src/SeabreezeEngine.cpp \
SeabreezeEngine.dox
INPUT = @TOP_SRCDIR@/Seabreeze/src/Node.cpp \
@TOP_SRCDIR@/Seabreeze/src/Seabreeze.cpp \
@TOP_SRCDIR@/Seabreeze/src/Seabreeze/Node.h \
@TOP_SRCDIR@/Seabreeze/src/Seabreeze/Seabreeze.h \
@TOP_SRCDIR@/Seabreeze/src/Seabreeze/Tree.h \
@TOP_SRCDIR@/Seabreeze/src/SeabreezeEngine.cpp \
@TOP_SRCDIR@/Seabreeze/src/Tree.cpp \
@TOP_SRCDIR@/Seabreeze/src/katabatic/SeabreezeEngine.h \
@DOCDIR@/Node.dox \
@DOCDIR@/Seabreeze.dox \
@DOCDIR@/Seabreeze.dox \
@DOCDIR@/SeabreezeEngine.dox \
@DOCDIR@/Tree.dox
# 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
@ -1293,7 +1293,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = Seabreeze
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -1931,7 +1931,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@ -2431,15 +2431,15 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES = ../../hurricane/doc/hurricane/html/hurricane.tag=../hurricane \
../../hurricane/doc/viewer/html/viewer.tag=../viewer \
../../crlcore/doc/crlcore/html/crlcore.tag=../crlcore
TAGFILES = "@TAGDIR@/hurricane.tag=../hurricane" \
"@TAGDIR@/viewer.tag=../viewer" \
"@TAGDIR@/crlcore.tag=../crlcore"
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/Seabreeze.tag
GENERATE_TAGFILE = "@TAGDIR@/Seabreeze.tag"
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

86
crlcore/doc/crlcore/doxyfile → crlcore/doc/crlcore/Doxyfile.in
View File

@ -1,4 +1,4 @@
# Doxyfile 1.9.8
@TAGDIR@# Doxyfile 1.9.8
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@ -48,7 +48,7 @@ PROJECT_NAME = "Coriolis Core (CRL)"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 3.0
PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = @DOCBUILDDIR@
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@ -274,10 +274,10 @@ TAB_SIZE = 2
# @} or use a double escape (\\{ and \\})
ALIASES = "function=\fn" \
"important=\par Important:\n" \
"caution=\par Caution:\n" \
"remark=\par Remark:\n" \
"sample=\par Sample:\n" \
"important=\par Important:^^" \
"caution=\par Caution:^^" \
"remark=\par Remark:^^" \
"sample=\par Sample:^^" \
"Return=<b>Returns:</b>" \
"unsigned=\c unsigned" \
"POD=\c POD" \
@ -964,30 +964,30 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ../../src/ccore/crlcore/Environment.h \
Environment.dox \
../../src/ccore/crlcore/Banner.h \
Banner.dox \
../../src/ccore/crlcore/Catalog.h \
Catalog.dox \
../../src/ccore/crlcore/SearchPath.h \
SearchPath.dox \
../../src/ccore/crlcore/AllianceLibrary.h \
AllianceLibrary.dox \
../../src/ccore/crlcore/RoutingLayerGauge.h \
RoutingLayerGauge.dox \
../../src/ccore/crlcore/RoutingGauge.h \
RoutingGauge.dox \
../../src/ccore/crlcore/AllianceFramework.h \
AllianceFramework.dox \
../../src/ccore/crlcore/AcmSigda.h \
AcmSigda.dox \
ToolEngine.dox \
../../src/ccore/crlcore/ToolEngine.h \
../../src/ccore/crlcore/ToolEngines.h \
GraphicTool.dox \
../../src/ccore/crlcore/GraphicToolEngine.h \
CRL.dox
INPUT = @TOP_SRCDIR@/crlcore/src/ccore/crlcore/AcmSigda.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/AllianceFramework.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/AllianceLibrary.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/Banner.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/Catalog.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/Environment.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/GraphicToolEngine.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/RoutingGauge.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/RoutingLayerGauge.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/SearchPath.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/ToolEngine.h \
@TOP_SRCDIR@/crlcore/src/ccore/crlcore/ToolEngines.h \
@DOCDIR@/AcmSigda.dox \
@DOCDIR@/AllianceFramework.dox \
@DOCDIR@/AllianceLibrary.dox \
@DOCDIR@/Banner.dox \
@DOCDIR@/CRL.dox \
@DOCDIR@/Catalog.dox \
@DOCDIR@/Environment.dox \
@DOCDIR@/GraphicTool.dox \
@DOCDIR@/RoutingGauge.dox \
@DOCDIR@/RoutingLayerGauge.dox \
@DOCDIR@/SearchPath.dox \
@DOCDIR@/ToolEngine.dox
# 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
@ -1094,7 +1094,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = images
IMAGE_PATH = @DOCDIR@/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@ -1287,7 +1287,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = crlcore
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -1314,7 +1314,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = header.html
HTML_HEADER = @DOCDIR@/header.html
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1324,7 +1324,7 @@ HTML_HEADER = header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = footer.html
HTML_FOOTER = @DOCDIR@/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@ -1336,7 +1336,7 @@ HTML_FOOTER = footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = SoC.css
HTML_STYLESHEET = @DOCDIR@/SoC.css
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@ -1925,7 +1925,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@ -1982,7 +1982,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
@ -2011,7 +2011,7 @@ EXTRA_PACKAGES =
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER = header.tex
LATEX_HEADER = @DOCDIR@/header.tex
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
@ -2425,15 +2425,15 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES = "../../../hurricane/doc/hurricane/html/hurricane.tag=../hurricane" \
"../../../hurricane/doc/viewer/html/viewer.tag=../viewer" \
"../../../unicorn/doc/unicorn/html/unicorn.tag=../unicorn"
TAGFILES = "@TAGDIR@/hurricane.tag=../hurricane" \
"@TAGDIR@/viewer.tag=../viewer" \
"@TAGDIR@/unicorn.tag=../unicorn"
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/crlcore.tag
GENERATE_TAGFILE = "@TAGDIR@/crlcore.tag"
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

25
crlcore/doc/crlcore/meson.build Normal file
View File

@ -0,0 +1,25 @@
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
cdata.set('TOP_SRCDIR', meson.project_source_root())
cdata.set('DOCDIR', meson.current_source_dir())
cdata.set('DOCBUILDDIR', meson.current_build_dir() / 'doc')
cdata.set('TAGDIR', meson.project_build_root())
doxyfile = configure_file(
input: 'Doxyfile.in',
output: 'Doxyfile',
configuration: cdata,
install: false
)
crlcore_docs = custom_target(
'crlcore-docs',
input: doxyfile,
output: 'doc',
command: [doxygen, doxyfile],
depends: [hurricane_docs, viewer_docs], #unicorn_docs
install: true,
install_dir: htmldir
)

1
crlcore/meson.build
View File

@ -3,6 +3,7 @@ subdir('src/LibraryManager')
subdir('src/cyclop')
subdir('src/pyCRL')
subdir('python')
subdir('doc/crlcore')
CrlCore = declare_dependency(
link_with: [crlcore, librarymanager, pycrlcore],

1
documentation/pelican-plugins Submodule

@ -0,0 +1 @@
Subproject commit 10a14332c35932b282b1ec63f0e10ae7d45aed8c

30
hurricane/doc/analog/doxyfile → hurricane/doc/analog/Doxyfile.in
View File

@ -48,7 +48,7 @@ PROJECT_NAME = "Hurricane Analog"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 3.0
PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = @DOCBUILDDIR@
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@ -274,10 +274,10 @@ TAB_SIZE = 2
# @} or use a double escape (\\{ and \\})
ALIASES = "function=\fn" \
"important=\par Important:\n" \
"caution=\par Caution:\n" \
"remark=\par Remark:\n" \
"sample=\par Sample:\n" \
"important=\par Important:^^" \
"caution=\par Caution:^^" \
"remark=\par Remark:^^" \
"sample=\par Sample:^^" \
"Return=<b>Returns:</b>" \
"unsigned=\c unsigned" \
"POD=\c POD" \
@ -964,7 +964,7 @@ WARN_LOGFILE = doxygen.warn.log
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = MainPage.dox
INPUT = @DOCDIR@/MainPage.dox
# 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
@ -1264,7 +1264,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = analog
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -1291,7 +1291,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = header.html
HTML_HEADER = @DOCDIR@/header.html
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1301,7 +1301,7 @@ HTML_HEADER = header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = footer.html
HTML_FOOTER = @DOCDIR@/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@ -1313,7 +1313,7 @@ HTML_FOOTER = footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = SoC.css
HTML_STYLESHEET = @DOCDIR@/SoC.css
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@ -1902,7 +1902,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@ -1959,7 +1959,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
@ -1988,7 +1988,7 @@ EXTRA_PACKAGES =
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER = header.tex
LATEX_HEADER = @DOCDIR@/header.tex
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
@ -2408,7 +2408,7 @@ TAGFILES =
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/hurricane.tag
GENERATE_TAGFILE = "@TAGDIR@/analog.tag"
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

26
hurricane/doc/analog/meson.build Normal file
View File

@ -0,0 +1,26 @@
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
cdata.set('TOP_SRCDIR', meson.project_source_root())
cdata.set('DOCDIR', meson.current_source_dir())
cdata.set('DOCBUILDDIR', meson.current_build_dir() / 'doc')
cdata.set('TAGDIR', meson.project_build_root())
doxyfile = configure_file(
input: 'Doxyfile.in',
output: 'Doxyfile',
configuration: cdata,
install: false
)
analog_docs = custom_target(
'analog-docs',
input: doxyfile,
output: 'doc',
command: [doxygen, doxyfile],
depends: hurricane_docs,
install: true,
install_dir: htmldir
)

2953
hurricane/doc/hurricane/Doxyfile.in Normal file
View File

File diff suppressed because it is too large Load Diff

2
hurricane/doc/hurricane/doxyfile
View File

@ -2565,7 +2565,7 @@ TAGFILES =
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/hurricane.tag
GENERATE_TAGFILE = "@TAGDIR@/hurricane.tag"
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

24
hurricane/doc/hurricane/meson.build Normal file
View File

@ -0,0 +1,24 @@
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
cdata.set('TOP_SRCDIR', meson.project_source_root())
cdata.set('DOCDIR', meson.current_source_dir())
cdata.set('DOCBUILDDIR', meson.current_build_dir() / 'doc')
cdata.set('TAGDIR', meson.project_build_root())
doxyfile = configure_file(
input: 'Doxyfile.in',
output: 'Doxyfile',
configuration: cdata,
install: false
)
hurricane_docs = custom_target(
'hurricane-docs',
input: doxyfile,
output: 'doc',
command: [doxygen, doxyfile],
install: true,
install_dir: htmldir
)

63
hurricane/doc/viewer/doxyfile → hurricane/doc/viewer/Doxyfile.in
View File

@ -1,4 +1,4 @@
# Doxyfile 1.9.8
# Doxyfile @DOCDIR@/1.9.8
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@ -27,7 +27,7 @@
# Project related configuration options
#---------------------------------------------------------------------------
# This tag specifies the encoding used for all characters in the configuration
@DOCDIR/# This tag specifies the encoding used for all characters in the configuration
# file that follow. The default is UTF-8 which is also the encoding used for all
# text before the first occurrence of this tag. Doxygen uses libiconv (or the
# iconv built into libc) for the transcoding. See
@ -48,7 +48,7 @@ PROJECT_NAME = "Hurricane Design Viewer"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 3.0
PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = @DOCBUILDDIR@
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@ -274,10 +274,10 @@ TAB_SIZE = 2
# @} or use a double escape (\\{ and \\})
ALIASES = "function=\fn" \
"important=\par Important:\n" \
"caution=\par Caution:\n" \
"remark=\par Remark:\n" \
"sample=\par Sample:\n" \
"important=\par Important:^^" \
"caution=\par Caution:^^" \
"remark=\par Remark:^^" \
"sample=\par Sample:^^" \
"Return=<b>Returns:</b>" \
"unsigned=\c unsigned" \
"POD=\c POD" \
@ -964,20 +964,21 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ../../src/viewer/hurricane/viewer/Graphics.h \
Graphics.dox \
../../src/viewer/hurricane/viewer/DisplayStyle.h \
DisplayStyle.dox \
../../src/viewer/hurricane/viewer/CellWidget.h \
CellWidget.dox \
../../src/viewer/hurricane/viewer/CellPrinter.h \
CellPrinter.dox \
../../src/viewer/hurricane/viewer/CellImage.h \
CellImage.dox \
../../src/viewer/hurricane/viewer/CellViewer.h \
CellViewer.dox \
../../src/viewer/hurricane/viewer/InspectorWidget.h \
InspectorWidget.dox
INPUT = @TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/CellImage.h \
@TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/CellPrinter.h \
@TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/CellViewer.h \
@TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/CellWidget.h \
@TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/DisplayStyle.h \
@TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/Graphics.h \
@TOP_SRCDIR@/hurricane/src/viewer/hurricane/viewer/InspectorWidget.h \
@DOCDIR@/CellImage.dox \
@DOCDIR@/CellPrinter.dox \
@DOCDIR@/CellViewer.dox \
@DOCDIR@/CellWidget.dox \
@DOCDIR@/DisplayStyle.dox \
@DOCDIR@/Graphics.dox \
@DOCDIR@/InspectorWidget.dox
# 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
@ -1084,7 +1085,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = images
IMAGE_PATH = @DOCDIR@/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@ -1277,7 +1278,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = viewer
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -1304,7 +1305,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = header.html
HTML_HEADER = "@DOCDIR@/header.html"
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1314,7 +1315,7 @@ HTML_HEADER = header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = footer.html
HTML_FOOTER = "@DOCDIR@/footer.html"
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@ -1326,7 +1327,7 @@ HTML_FOOTER = footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = SoC.css
HTML_STYLESHEET = "@DOCDIR@/SoC.css"
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@ -1972,7 +1973,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
@ -2001,7 +2002,7 @@ EXTRA_PACKAGES =
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER = header.tex
LATEX_HEADER = "@DOCDIR@/header.tex"
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
@ -2415,13 +2416,13 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES = "../hurricane/html/hurricane.tag=../hurricane"
TAGFILES = "@TAGDIR@/hurricane.tag=../hurricane"
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/viewer.tag
GENERATE_TAGFILE = "@TAGDIR@/viewer.tag"
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

25
hurricane/doc/viewer/meson.build Normal file
View File

@ -0,0 +1,25 @@
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
cdata.set('TOP_SRCDIR', meson.project_source_root())
cdata.set('DOCDIR', meson.current_source_dir())
cdata.set('DOCBUILDDIR', meson.current_build_dir() / 'doc')
cdata.set('TAGDIR', meson.project_build_root())
doxyfile = configure_file(
input: 'Doxyfile.in',
output: 'Doxyfile',
configuration: cdata,
install: false
)
viewer_docs = custom_target(
'viewer-docs',
input: doxyfile,
output: 'doc',
command: [doxygen, doxyfile],
depends: hurricane_docs,
install: true,
install_dir: htmldir
)

4
hurricane/meson.build
View File

@ -1,4 +1,6 @@
bzip2 = cc.find_library('bz2', required: true)
rapidjson = dependency('RapidJSON', required: true)
subdir('src')
subdir('doc/hurricane')
subdir('doc/viewer')
subdir('doc/analog')

8
meson.build
View File

@ -52,6 +52,12 @@ flex = find_program('flex', required: true)
bison = find_program('bison', required: true)
thread_dep = dependency('threads')
doxygen = find_program('doxygen', required: true)
dot = find_program('dot', required: true)
docdir = join_paths(get_option('datadir'), 'doc')
htmldir = join_paths(docdir, 'html')
if build_machine.system() == 'darwin'
add_project_arguments('-mmacosx-version-min=13.0', language: ['c','cpp'])
@ -83,9 +89,9 @@ subdir('katana')
subdir('tramontana')
subdir('equinox')
subdir('solstice')
subdir('unicorn')
subdir('oroshi')
subdir('bora')
subdir('unicorn')
subdir('cumulus')
subdir('tutorial')

48
oroshi/doc/doxyfile → oroshi/doc/Doxyfile.in
View File

@ -1,4 +1,4 @@
# Doxyfile 1.9.8
"#oxyfile 1.9.8
# This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project.
@ -48,7 +48,7 @@ PROJECT_NAME = "Oroshi - Analog Devices Layout"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.0
PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = @DOCBUILDDIR@
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@ -284,8 +284,8 @@ TAB_SIZE = 2
# @} or use a double escape (\\{ and \\})
ALIASES = "function=\fn" \
"important=\par Important:\n" \
"remark=\par Remark:\n" \
"important=\par Important:^^" \
"remark=\par Remark:^^" \
"sreturn=\b Returns:" \
"True=\b True" \
"true=\b true" \
@ -981,14 +981,14 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ../python/stack.py \
../python/wip_transistor.py \
../python/wip_dp.py \
../python/wip_csp.py \
../python/capacitorunit.py \
../python/capacitormatrix.py \
../python/capacitorrouted.py \
../python/capacitorvrtracks.py
INPUT = @TOP_SRCDIR@/oroshi/python/stack.py \
@TOP_SRCDIR@/oroshi/python/wip_transistor.py \
@TOP_SRCDIR@/oroshi/python/wip_dp.py \
@TOP_SRCDIR@/oroshi/python/wip_csp.py \
@TOP_SRCDIR@/oroshi/python/capacitorunit.py \
@TOP_SRCDIR@/oroshi/python/capacitormatrix.py \
@TOP_SRCDIR@/oroshi/python/capacitorrouted.py \
@TOP_SRCDIR@/oroshi/python/capacitorvrtracks.py
# 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
@ -1093,7 +1093,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = images
IMAGE_PATH = @DOCDIR@/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@ -1286,7 +1286,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = oroshi
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -1313,7 +1313,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = header.html
HTML_HEADER = "@DOCDIR@/header.html"
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1323,7 +1323,7 @@ HTML_HEADER = header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = footer.html
HTML_FOOTER = "@DOCDIR@/footer.html"
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@ -1335,7 +1335,7 @@ HTML_FOOTER = footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = SoC.css
HTML_STYLESHEET = "@DOCDIR@/SoC.css"
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@ -1924,7 +1924,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@ -2010,7 +2010,7 @@ EXTRA_PACKAGES =
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER = header.tex
LATEX_HEADER = "@DOCDIR@/header.tex"
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
@ -2424,15 +2424,15 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES = ../../hurricane/doc/hurricane/html/hurricane.tag=../hurricane \
../../hurricane/doc/viewer/html/viewer.tag=../viewer \
../../crlcore/doc/crlcore/html/crlcore.tag=../crlcore
TAGFILES = "@TAGDIR@/hurricane.tag=../hurricane" \
"@TAGDIR@/viewer.tag=../viewer" \
"@TAGDIR@/crlcore.tag=../crlcore"
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/katabatic.tag
GENERATE_TAGFILE = @TAGDIR@/oroshi.tag
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

25
oroshi/doc/meson.build Normal file
View File

@ -0,0 +1,25 @@
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
cdata.set('TOP_SRCDIR', meson.project_source_root())
cdata.set('DOCDIR', meson.current_source_dir())
cdata.set('DOCBUILDDIR', meson.current_build_dir() / 'oroshi')
cdata.set('TAGDIR', meson.project_build_root())
doxyfile = configure_file(
input: 'Doxyfile.in',
output: 'Doxyfile',
configuration: cdata,
install: false
)
oroshi_docs = custom_target(
'oroshi-docs',
input: doxyfile,
output: 'oroshi',
command: [doxygen, doxyfile],
depends: [hurricane_docs, viewer_docs, crlcore_docs],
install: true,
install_dir: htmldir
)

1
oroshi/meson.build
View File

@ -1,4 +1,5 @@
subdir('python')
subdir('doc')
Oroshi = declare_dependency(
dependencies: [CrlCore]

44
unicorn/doc/unicorn/doxyfile → unicorn/doc/unicorn/Doxyfile.in
View File

@ -48,7 +48,7 @@ PROJECT_NAME = "Unicorn - Coriolis GUI"
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER = 1.0
PROJECT_NUMBER = @VERSION@
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
@ -68,7 +68,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.
OUTPUT_DIRECTORY = .
OUTPUT_DIRECTORY = @DOCBUILDDIR@
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
# sub-directories (in 2 levels) under the output directory of each output format
@ -274,10 +274,10 @@ TAB_SIZE = 2
# @} or use a double escape (\\{ and \\})
ALIASES = "function=\fn" \
"important=\par Important:\n" \
"caution=\par Caution:\n" \
"remark=\par Remark:\n" \
"sample=\par Sample:\n" \
"important=\par Important:^^" \
"caution=\par Caution:^^" \
"remark=\par Remark:^^" \
"sample=\par Sample:^^" \
"Return=<b>Returns:</b>" \
"unsigned=\c unsigned" \
"POD=\c POD" \
@ -964,9 +964,9 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ../../src/unicorn/UnicornGui.h \
UnicornGui.dox \
Unicorn.dox
INPUT = @TOP_SRCDIR@/unicorn/src/unicorn/UnicornGui.h \
@DOCDIR@/Unicorn.dox \
@DOCDIR@/UnicornGui.dox
# 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
@ -1073,7 +1073,7 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
IMAGE_PATH = images
IMAGE_PATH = @DOCDIR@/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@ -1266,7 +1266,7 @@ GENERATE_HTML = YES
# The default directory is: html.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_OUTPUT = html
HTML_OUTPUT = unicorn
# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
# generated HTML page (for example: .htm, .php, .asp).
@ -1293,7 +1293,7 @@ HTML_FILE_EXTENSION = .html
# of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_HEADER = header.html
HTML_HEADER = @DOCDIR@/header.html
# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
# generated HTML page. If the tag is left blank doxygen will generate a standard
@ -1303,7 +1303,7 @@ HTML_HEADER = header.html
# that doxygen normally uses.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FOOTER = footer.html
HTML_FOOTER = @DOCDIR@/footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
# sheet that is used by each HTML page. It can be used to fine-tune the look of
@ -1315,7 +1315,7 @@ HTML_FOOTER = footer.html
# obsolete.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_STYLESHEET = SoC.css
HTML_STYLESHEET = @DOCDIR@/SoC.css
# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# cascading style sheets that are included after the standard style sheets
@ -1904,7 +1904,7 @@ EXTRA_SEARCH_MAPPINGS =
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@ -1961,7 +1961,7 @@ COMPACT_LATEX = NO
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4wide
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
@ -1990,7 +1990,7 @@ EXTRA_PACKAGES =
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER = header.tex
LATEX_HEADER = @DOCDIR@/header.tex
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
@ -2404,17 +2404,15 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES = "../../../hurricane/doc/hurricane/html/hurricane.tag=../hurricane" \
"../../../hurricane/doc/viewer/html/viewer.tag=../viewer" \
"../../../crlcore/doc/crlcore/html/crlcore.tag=../crlcore" \
"../../../katabatic/doc/html/katabatic.tag=../katabatic" \
"../../../kite/doc/html/kite.tag=../kite"
TAGFILES = "@TAGDIR@/hurricane.tag=../hurricane" \
"@TAGDIR@/viewer.tag=../viewer" \
"@TAGDIR@/crlcore.tag=../crlcore"
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE = html/unicorn.tag
GENERATE_TAGFILE = "@TAGDIR@/unicorn.tag"
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the

25
unicorn/doc/unicorn/meson.build Normal file
View File

@ -0,0 +1,25 @@
cdata = configuration_data()
cdata.set('VERSION', meson.project_version())
cdata.set('TOP_SRCDIR', meson.project_source_root())
cdata.set('DOCDIR', meson.current_source_dir())
cdata.set('DOCBUILDDIR', meson.current_build_dir() / 'doc')
cdata.set('TAGDIR', meson.project_build_root())
doxyfile = configure_file(
input: 'Doxyfile.in',
output: 'Doxyfile',
configuration: cdata,
install: false
)
unicorn_docs = custom_target(
'unicorn-docs',
input: doxyfile,
output: 'doc',
command: [doxygen, doxyfile],
depends: [hurricane_docs, viewer_docs, crlcore_docs],
install: true,
install_dir: htmldir
)

1
unicorn/meson.build
View File

@ -1,5 +1,6 @@
subdir('src')
subdir('python')
subdir('doc/unicorn')
Unicorn = declare_dependency(
link_with: [unicorn],