Skip to content

Commit

Permalink
Doc: aligning on doxygen filenames, plus link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
vovamarch authored Nov 14, 2023
1 parent 7364190 commit ec4bf84
Show file tree
Hide file tree
Showing 64 changed files with 138 additions and 316 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/pack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ jobs:
- uses: Open-CMSIS-Pack/gen-pack-action@main
with:
doxygen-version: 1.9.6
packchk-version: 1.3.98
packchk-version: 1.4.1
gen-doc-script: ./CMSIS/Documentation/Doxygen/gen_doc.sh
doc-path: ./CMSIS/Documentation/html
gen-pack-script: ./gen_pack.sh --no-preprocess
Expand Down
14 changes: 7 additions & 7 deletions CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser.xml
LAYOUT_FILE = ../style_template/layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1372,6 +1372,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1381,13 +1383,11 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png \
../style_template/dropdown.png

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down Expand Up @@ -1729,7 +1729,7 @@ ENUM_VALUES_PER_LINE = 0
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
50 changes: 25 additions & 25 deletions CMSIS/Documentation/Doxygen/Core/Core.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -797,7 +797,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser_Core.xml
LAYOUT_FILE = ../style_template/layout_core.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -932,25 +932,25 @@ INPUT = ./src/mainpage.md \
./src/core_files_in_packs.md \
./src/misra.md \
./src/register_mapping.md \
./src/Ref_DevCaps.txt \
./src/Ref_VersionControl.txt \
./src/Ref_CompilerControl.txt \
./src/Ref_Peripheral.txt \
./src/Ref_SystemAndClock.txt \
./src/Ref_NVIC.txt \
./src/Ref_CoreRegister.txt \
./src/Ref_cmInstr.txt \
./src/Ref_cm4_simd.txt \
./src/Ref_FPU.txt \
./src/Ref_MVE.txt \
./src/Ref_MPU.txt \
./src/Ref_MPU8.txt \
./src/Ref_PMU8.txt \
./src/Ref_Systick.txt \
./src/Ref_Debug.txt \
./src/Ref_Trustzone.txt \
./src/core_cm7.txt \
./src/Ref_DataStructs.txt
./src/ref_device_caps.txt \
./src/ref_version_ctrl.txt \
./src/ref_compiler_ctrl.txt \
./src/ref_peripheral.txt \
./src/ref_system_init.txt \
./src/ref_nvic.txt \
./src/ref_core_reg.txt \
./src/ref_cm_instr.txt \
./src/ref_cm4_simd.txt \
./src/ref_fpu.txt \
./src/ref_mve.txt \
./src/ref_mpu.txt \
./src/ref_mpu8.txt \
./src/ref_pmu8.txt \
./src/ref_systick.txt \
./src/ref_debug.txt \
./src/ref_trustzone.txt \
./src/ref_cm7_cache.txt \
./src/ref_data_structs.txt

# 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
Expand Down Expand Up @@ -1409,6 +1409,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1418,10 +1420,8 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png
Expand Down Expand Up @@ -1766,7 +1766,7 @@ ENUM_VALUES_PER_LINE = 1
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
30 changes: 15 additions & 15 deletions CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser_Core.xml
LAYOUT_FILE = ../style_template/layout_core.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -926,15 +926,15 @@ INPUT = ./src/mainpage.md \
./../../../Core/Include/a-profile/cmsis_cp15.h \
./../../../Core/Include/a-profile/irq_ctrl.h \
./../../../Core/Source/irq_ctrl_gic.c \
./src/Ref_SystemAndClock.txt \
./src/Ref_GIC.txt \
./src/Ref_CoreRegister.txt \
./src/Ref_Cache.txt \
./src/Ref_Timer.txt \
./src/Ref_MMU.txt \
./src/core_ca.txt \
./src/Ref_CompilerControl.txt \
./src/Ref_IRQCtrl.txt \
./src/ref_system_init.txt \
./src/ref_gic.txt \
./src/ref_core_reg.txt \
./src/ref_cache.txt \
./src/ref_timer.txt \
./src/ref_mmu.txt \
./src/ref_core_ca.txt \
./src/ref_compiler_ctrl.txt \
./src/ref_irq_ctrl.txt \

# 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
Expand Down Expand Up @@ -1392,6 +1392,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1401,10 +1403,8 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png
Expand Down Expand Up @@ -1749,7 +1749,7 @@ ENUM_VALUES_PER_LINE = 1
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
/**************************************************************************//**
* @file Ref_CompilerControl.txt
* @brief CMSIS compiler specific macros, functions, instructions
* @version V1.00
* @date 22. Feb 2017
******************************************************************************/
/* CMSIS compiler control architecture macros */
/* ########################## Compiler control architecture macros ################################# */
/**
\defgroup comp_cntrl_gr Compiler Control
\brief Compiler agnostic \#define symbols for generic C/C++ source code
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
/**************************************************************************//**
* @file core_ca.txt
* @brief CMSIS Cortex-A Core Peripheral Access Layer Header File
******************************************************************************/

/* IO definitions (access restrictions to peripheral registers) */
/**
\defgroup peripheral_gr Peripheral Access
Expand Down
14 changes: 7 additions & 7 deletions CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser.xml
LAYOUT_FILE = ../style_template/layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1372,6 +1372,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1381,13 +1383,11 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png \
../style_template/dropdown.png

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down Expand Up @@ -1729,7 +1729,7 @@ ENUM_VALUES_PER_LINE = 0
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
14 changes: 7 additions & 7 deletions CMSIS/Documentation/Doxygen/DSP/DSP.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser.xml
LAYOUT_FILE = ../style_template/layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1372,6 +1372,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1381,13 +1383,11 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png \
../style_template/dropdown.png

# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
Expand Down Expand Up @@ -1729,7 +1729,7 @@ ENUM_VALUES_PER_LINE = 0
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
12 changes: 6 additions & 6 deletions CMSIS/Documentation/Doxygen/Driver/Driver.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -797,7 +797,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser.xml
LAYOUT_FILE = ../style_template/layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1417,6 +1417,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1426,10 +1428,8 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png
Expand Down Expand Up @@ -1774,7 +1774,7 @@ ENUM_VALUES_PER_LINE = 1
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
12 changes: 6 additions & 6 deletions CMSIS/Documentation/Doxygen/General/General.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -795,7 +795,7 @@ FILE_VERSION_FILTER =
# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
# tag is left empty.

LAYOUT_FILE = ../style_template/Layout_forUser.xml
LAYOUT_FILE = ../style_template/layout.xml

# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
# the reference definitions. This must be a list of .bib files. The .bib
Expand Down Expand Up @@ -1375,6 +1375,8 @@ HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
../style_template/extra_navtree.css \
../style_template/extra_search.css \
../style_template/extra_tabs.css \
../style_template/version.css

# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the HTML output directory. Note
Expand All @@ -1384,10 +1386,8 @@ HTML_EXTRA_STYLESHEET = ../style_template/extra_stylesheet.css \
# files will be copied as-is; there are no commands or markers available.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_EXTRA_FILES = ../style_template/tabs.css \
../style_template/version.css \
../style_template/tab_b.png \
../style_template/printComponentTabs.js \
HTML_EXTRA_FILES = ../style_template/tab_b.png \
../style_template/tabs.js \
../style_template/darkmode_toggle.js \
../style_template/navtree.js \
../style_template/dropdown.png
Expand Down Expand Up @@ -1732,7 +1732,7 @@ ENUM_VALUES_PER_LINE = 0
# Minimum value: 0, maximum value: 1500, default value: 250.
# This tag requires that the tag GENERATE_HTML is set to YES.

TREEVIEW_WIDTH = 250
TREEVIEW_WIDTH = 330

# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
# external symbols imported via tag files in a separate window.
Expand Down
Loading

0 comments on commit ec4bf84

Please sign in to comment.