Home
last modified time | relevance | path

Searched full:doxygen (Results 1 – 25 of 57) sorted by relevance

123

/Zephyr-latest/doc/_extensions/zephyr/
Ddoxyrunner.py11 This Sphinx plugin can be used to run Doxygen build as part of the Sphinx build
16 - Doxygen build is run before Sphinx reads input files
18 - Changes in the Doxygen input files are tracked so that Doxygen build is only
20 - Synchronizes Doxygen XML output so that even if Doxygen is run only changed,
30 - ``doxyrunner_doxygen``: Path to the Doxygen binary.
32 - ``doxyrunner_outdir``: Doxygen build output directory (inserted to
34 - ``doxyrunner_outdir_var``: Variable representing the Doxygen build output
36 Doxygen variables reference to the output directory.
40 - ``doxyrunner_silent``: If Doxygen output should be logged or not. Note that
80 """Obtain the value of a Doxygen option.
[all …]
Dapi_overview.py18 version it is present - all information extracted from Doxygen XML output.
24 api_overview_doxygen_xml_dir: Doxygen xml output directory
25 api_overview_doxygen_base_url: Doxygen base html directory
167 app.add_config_value("api_overview_doxygen_xml_dir", "html/doxygen/xml", "env")
168 app.add_config_value("api_overview_doxygen_base_url", "../../doxygen/html", "env")
Ddoxybridge.py61 """Mapping between Doxygen memberdef kind and Sphinx kinds"""
/Zephyr-latest/doc/project/
Ddocumentation.rst10 requirement for defining an API's success. Doxygen is a general purpose
14 documented source files. In particular, doxygen's XML output is used as an input
56 - All test code documentation should be grouped under the ``all_tests`` doxygen
58 - All test documentation should be under doxygen groups that are prefixed
61 The custom doxygen ``@verify`` directive signifies that a test verifies a
90 requirements, we use the ``satisfy`` alias in doxygen::
109 specifically you will need to build the doxygen XML output::
111 $ make doxygen
113 Parse the generated XML data from doxygen to generate the traceability matrix.
/Zephyr-latest/doc/
Dzephyr.doxyfile.in4 # Doxygen (www.doxygen.org) for a project.
18 # Use Doxygen to compare the used configuration file with the template
20 # doxygen -x [configFile]
21 # Use Doxygen to compare the used configuration file with the template
24 # doxygen -x_noenv [configFile]
32 # text before the first occurrence of this tag. Doxygen uses libiconv (or the
61 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
67 # when the HTML document is shown. Doxygen will copy the logo to the output
74 # entered, it will be relative to the location where Doxygen was started. If
79 # If the CREATE_SUBDIRS tag is set to YES then Doxygen will create up to 4096
[all …]
DMakefile15 .PHONY: configure clean html html-fast html-live html-live-fast latex pdf doxygen
23 html html-live latex pdf linkcheck doxygen: configure target
DCMakeLists.txt29 find_package(Doxygen REQUIRED dot)
56 message(FATAL_ERROR "Zephyr Doxygen overlay $ENV{ZEPHYR_DOXYGEN_OVERLAY} does not exist!")
97 # Doxygen (standalone)
99 set(DOXY_OUT ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
107 doxygen target
110 COMMENT "Running Doxygen..."
114 doxygen
Drequirements.txt22 # Doxygen doxmlparser
Dconf.py205 "API": f"{reference_prefix}/doxygen/html/index.html",
248 doxyrunner_doxygen = os.environ.get("DOXYGEN_EXECUTABLE", "doxygen")
250 doxyrunner_outdir = ZEPHYR_BUILD / "doxygen"
359 api_overview_doxygen_base_url = "../../doxygen/html"
/Zephyr-latest/doc/contribute/documentation/
Dgeneration.rst36 * Doxygen-generated material used to create all API-specific documents
59 header -> doxygen
60 doxygen -> xml
68 and make use of the doxygen-generated API material.
79 * Doxygen version 1.8.13
107 sudo apt-get install --no-install-recommends doxygen graphviz librsvg2-bin \
114 sudo dnf install doxygen graphviz texlive-latex latexmk \
127 sudo pacman -S graphviz doxygen librsvg texlive-core texlive-bin \
142 brew install doxygen graphviz mactex librsvg imagemagick
158 choco install doxygen.install graphviz strawberryperl miktex rsvg-convert imagemagick
[all …]
Dguidelines.rst686 You may use these roles to cross-reference the Doxygen documentation of C functions, macros,
689 They are rendered in the HTML output as links to the corresponding Doxygen documentation for the
987 Doxygen API documentation
995 This directive is used to output a short description of a Doxygen group and a link to the
996 corresponding Doxygen-generated documentation.
1011 This role is used to reference a Doxygen group in the Zephyr tree. In the HTML documentation,
1012 they are rendered as links to the corresponding Doxygen-generated documentation for the group.
1096 Optional space-separated list of Doxygen group names that correspond to the APIs exercised
/Zephyr-latest/doc/_doxygen/
Dheader.html1 <!-- HTML header for doxygen 1.12.0-->
7 <meta name="generator" content="Doxygen $doxygenversion"/>
25 <script type="text/javascript" src="$relpath^doxygen-awesome-darkmode-toggle.js"></script>
26 <script type="text/javascript" src="$relpath^doxygen-awesome-zephyr.js"></script>
40 …" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
44 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
Ddoxygen-awesome-sidebar-only-darkmode-toggle.css4 Doxygen Awesome
5 https://github.com/jothepro/doxygen-awesome-css
Ddoxygen-awesome.css3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
247 /* dark mode variables are defined twice, to support both the dark-mode without and with doxygen-aw…
558 /* until Doxygen 1.9.4 */
565 /* Doxygen 1.9.5 */
758 * Overwrites for fixing the searchbox on mobile in doxygen 1.9.2
1244 .contents > .doxygen-awesome-fragment-wrapper > div.fragment,
1245 .textblock > .doxygen-awesome-fragment-wrapper > div.fragment,
1246 .textblock > .doxygen-awesome-fragment-wrapper > pre.fragment,
1247 .textblock > .tabbed > ul > li > .doxygen-awesome-fragment-wrapper > div.fragment,
[all …]
Ddoxygen-awesome-sidebar-only.css3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
Ddoxygen-awesome-darkmode-toggle.js3 Doxygen Awesome
4 https://github.com/jothepro/doxygen-awesome-css
61 const toggleButton = document.createElement('doxygen-awesome-dark-mode-toggle')
157 customElements.define("doxygen-awesome-dark-mode-toggle", DoxygenAwesomeDarkModeToggle);
/Zephyr-latest/.github/workflows/
Ddoc-build.yml77 …wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION/…
78 sudo tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz -C /opt
79 echo "/opt/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
141 …python3 -m coverxygen --xml-dir doc/_build/html/doxygen/xml/ --src-dir include/ --output doc-cove…
149 … tar --use-compress-program="xz -T0" -cf api-output.tar.xz --directory=doc/_build html/doxygen/html
170 API_DOC_URL="https://builds.zephyrproject.io/${REPO_NAME}/pr/${PR_NUM}/docs/doxygen/html/"
209 … apt-get install -y python3-pip python3-venv ninja-build doxygen graphviz librsvg2-bin imagemagick
Ddoc-publish.yml57 …aws s3 sync --quiet html-output/html/doxygen/html s3://docs.zephyrproject.org/apidoc/${VERSION} --…
/Zephyr-latest/doc/_extensions/zephyr/doxytooltip/static/
Ddoxytooltip.js6 * Doxygen documentation as tooltips when hovering over a symbol in the
70 /* Grab the main stylesheets from the Doxygen page and inject them in the tooltip's
72 const doxygenCSSNames = ['doxygen-awesome.css', 'doxygen-awesome-zephyr.css'];
109 // rewrite all relative links as they are originally relative to the Doxygen page
Ddoxytooltip.css2 /* provide minimal definition of the CSS variables used by Doxygen Awesome so that we have a
/Zephyr-latest/doc/_extensions/zephyr/doxytooltip/
D__init__.py2 Doxygen Tooltip Extension
/Zephyr-latest/doc/templates/
Dsample.tmpl3 :relevant-api: space-separated list of Doxygen groups of APIs this sample is a good showcase of
/Zephyr-latest/
D.gitignore35 doc/doxygen
/Zephyr-latest/boards/intel/socfpga_std/cyclonev_socdk/doc/
Dindex.rst234 For bug reports, read http://openocd.org/doc/doxygen/bugs.html
277 For bug reports, read http://openocd.org/doc/doxygen/bugs.html
303 For bug reports, read http://openocd.org/doc/doxygen/bugs.html
/Zephyr-latest/doc/releases/
Drelease-notes-1.6.rst244 * ``ZEP-981`` - Add doxygen documentation to both include/kernel.h and include/legacy.h
335 * ``ZEP-1182`` - kernel.h doxygen show unexpected "asm" blocks
353 * ``ZEP-1295`` - incorrect doxygen comment in kernel.h:k_work_pending()

123