Doc: Varios alignment updates

ARM-software · Oct 31, 2023 · d47145c · d47145c
1 parent 5720958
commit d47145c
Show file tree

Hide file tree

Showing 42 changed files with 219 additions and 211 deletions.
diff --git a/CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in b/CMSIS/Documentation/Doxygen/Compiler/Compiler.dxy.in
@@ -60,7 +60,7 @@ PROJECT_BRIEF          = "Retarget standard C library file, I/O and OS functions
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ../Doxygen_Templates/cmsis_logo_white_small.png
+PROJECT_LOGO           = ../style_template/cmsis_logo_white_small.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -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            = ../Doxygen_Templates/Layout_forUser.xml
+LAYOUT_FILE            = ../style_template/Layout_forUser.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
@@ -1329,7 +1329,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            = ../Doxygen_Templates/header.html
+HTML_HEADER            = ../style_template/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
@@ -1339,7 +1339,7 @@ HTML_HEADER            = ../Doxygen_Templates/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = ../Doxygen_Templates/footer.html
+HTML_FOOTER            = ../style_template/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
@@ -1369,9 +1369,9 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/extra_stylesheet.css \
-                         ../Doxygen_Templates/extra_navtree.css \
-                         ../Doxygen_Templates/extra_search.css \
+HTML_EXTRA_STYLESHEET  = ../style_template/extra_stylesheet.css \
+                         ../style_template/extra_navtree.css \
+                         ../style_template/extra_search.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
@@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/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       = ../Doxygen_Templates/tabs.css \
-                         ../Doxygen_Templates/version.css \
-                         ../Doxygen_Templates/tab_b.png \
-                         ../Doxygen_Templates/printComponentTabs.js \
-                         ../Doxygen_Templates/darkmode_toggle.js \
-                         ../Doxygen_Templates/navtree.js \
-                         ../Doxygen_Templates/dropdown.png \
+HTML_EXTRA_FILES       = ../style_template/tabs.css \
+                         ../style_template/version.css \
+                         ../style_template/tab_b.png \
+                         ../style_template/printComponentTabs.js \
+                         ../style_template/darkmode_toggle.js \
+                         ../style_template/navtree.js \
+                         ../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.

diff --git a/CMSIS/Documentation/Doxygen/Compiler/src/mainpage.md b/CMSIS/Documentation/Doxygen/Compiler/src/mainpage.md
@@ -14,8 +14,9 @@ Standard C library functions are platform independent, but the implementations o
 
 CMSIS-Compiler is maintained in a GitHub repository and is also released as a standalone package in CMSIS Pack format.
 
- - [**CMSIS-Compiler GitHub Repo**](https://github.com/Arm-Software/CMSIS-Compiler) provides the full source code as well as releases in CMSIS-Pack format.
+ - [**CMSIS-Compiler GitHub Repo**](https://github.com/Arm-Software/CMSIS-Compiler) provides the full source code of CMSIS-Compiler components.
  - [**CMSIS-Compiler Documentation**](https://arm-software.github.io/CMSIS-Compiler/latest/) explains how to use the library and describes the implemented functions in details.
+ - [**CMSIS-Compiler Pack**](https://www.keil.arm.com/packs/cmsis-compiler-arm/versions/) delivers CMSIS-Compiler components and examples in [CMSIS-Pack format](https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html).
 
 ## Key Features and Benefits
 

diff --git a/CMSIS/Documentation/Doxygen/Core/Core.dxy.in b/CMSIS/Documentation/Doxygen/Core/Core.dxy.in
@@ -60,7 +60,7 @@ PROJECT_BRIEF          = "CMSIS-Core support for Cortex-M processor-based device
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ../Doxygen_Templates/cmsis_logo_white_small.png
+PROJECT_LOGO           = ../style_template/cmsis_logo_white_small.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -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            = ../Doxygen_Templates/Layout_forUser_Core.xml
+LAYOUT_FILE            = ../style_template/Layout_forUser_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
@@ -1366,7 +1366,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            = ../Doxygen_Templates/header.html
+HTML_HEADER            = ../style_template/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
@@ -1376,7 +1376,7 @@ HTML_HEADER            = ../Doxygen_Templates/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = ../Doxygen_Templates/footer.html
+HTML_FOOTER            = ../style_template/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
@@ -1406,9 +1406,9 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/extra_stylesheet.css \
-                         ../Doxygen_Templates/extra_navtree.css \
-                         ../Doxygen_Templates/extra_search.css \
+HTML_EXTRA_STYLESHEET  = ../style_template/extra_stylesheet.css \
+                         ../style_template/extra_navtree.css \
+                         ../style_template/extra_search.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
@@ -1418,13 +1418,13 @@ HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/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       = ../Doxygen_Templates/tabs.css \
-                         ../Doxygen_Templates/version.css \
-                         ../Doxygen_Templates/tab_b.png \
-                         ../Doxygen_Templates/printComponentTabs.js \
-                         ../Doxygen_Templates/darkmode_toggle.js \
-                         ../Doxygen_Templates/navtree.js \
-                         ../Doxygen_Templates/dropdown.png
+HTML_EXTRA_FILES       = ../style_template/tabs.css \
+                         ../style_template/version.css \
+                         ../style_template/tab_b.png \
+                         ../style_template/printComponentTabs.js \
+                         ../style_template/darkmode_toggle.js \
+                         ../style_template/navtree.js \
+                         ../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.

diff --git a/CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in b/CMSIS/Documentation/Doxygen/Core_A/Core_A.dxy.in
@@ -60,7 +60,7 @@ PROJECT_BRIEF          = "CMSIS-Core support for Cortex-A processor-based device
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ../Doxygen_Templates/cmsis_logo_white_small.png
+PROJECT_LOGO           = ../style_template/cmsis_logo_white_small.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -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            = ../Doxygen_Templates/Layout_forUser_Core.xml
+LAYOUT_FILE            = ../style_template/Layout_forUser_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
@@ -1349,7 +1349,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            = ../Doxygen_Templates/header.html
+HTML_HEADER            = ../style_template/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
@@ -1359,7 +1359,7 @@ HTML_HEADER            = ../Doxygen_Templates/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = ../Doxygen_Templates/footer.html
+HTML_FOOTER            = ../style_template/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
@@ -1389,9 +1389,9 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/extra_stylesheet.css \
-                         ../Doxygen_Templates/extra_navtree.css \
-                         ../Doxygen_Templates/extra_search.css \
+HTML_EXTRA_STYLESHEET  = ../style_template/extra_stylesheet.css \
+                         ../style_template/extra_navtree.css \
+                         ../style_template/extra_search.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
@@ -1401,13 +1401,13 @@ HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/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       = ../Doxygen_Templates/tabs.css \
-                         ../Doxygen_Templates/version.css \
-                         ../Doxygen_Templates/tab_b.png \
-                         ../Doxygen_Templates/printComponentTabs.js \
-                         ../Doxygen_Templates/darkmode_toggle.js \
-                         ../Doxygen_Templates/navtree.js \
-                         ../Doxygen_Templates/dropdown.png
+HTML_EXTRA_FILES       = ../style_template/tabs.css \
+                         ../style_template/version.css \
+                         ../style_template/tab_b.png \
+                         ../style_template/printComponentTabs.js \
+                         ../style_template/darkmode_toggle.js \
+                         ../style_template/navtree.js \
+                         ../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.

diff --git a/CMSIS/Documentation/Doxygen/Core_A/src/Ref_CoreRegister.txt b/CMSIS/Documentation/Doxygen/Core_A/src/Ref_CoreRegister.txt
@@ -66,13 +66,13 @@ The ACTLR characteristics are differs between various Armv7-A implementations.
 | [1]     | -             | Reserved.                                                     |
 | [0]     | FW            | Cache and TLB maintenance broadcast.                          |
 
-Consider using \ref __get_ACTLR and \ref __set_ACTRL to access ACTRL register.
+Consider using \ref __get_ACTLR and \ref __set_ACTLR to access ACTRL register.
 
 @{
 */
 
 /**
-\fn __STATIC_INLINE void __set_ACTRL(uint32_t actrl)
+\fn __STATIC_INLINE void __set_ACTLR(uint32_t actlr)
 \details
   This function assigns the given value to the \ref CMSIS_ACTLR.
 

diff --git a/CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in b/CMSIS/Documentation/Doxygen/DAP/DAP.dxy.in
@@ -60,7 +60,7 @@ PROJECT_BRIEF          = "Interface Firmware for CoreSight Debug Access Port"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ../Doxygen_Templates/cmsis_logo_white_small.png
+PROJECT_LOGO           = ../style_template/cmsis_logo_white_small.png
 
 # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
 # into which the generated documentation will be written. If a relative path is
@@ -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            = ../Doxygen_Templates/Layout_forUser.xml
+LAYOUT_FILE            = ../style_template/Layout_forUser.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
@@ -1329,7 +1329,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            = ../Doxygen_Templates/header.html
+HTML_HEADER            = ../style_template/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
@@ -1339,7 +1339,7 @@ HTML_HEADER            = ../Doxygen_Templates/header.html
 # that doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = ../Doxygen_Templates/footer.html
+HTML_FOOTER            = ../style_template/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
@@ -1369,9 +1369,9 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/extra_stylesheet.css \
-                         ../Doxygen_Templates/extra_navtree.css \
-                         ../Doxygen_Templates/extra_search.css \
+HTML_EXTRA_STYLESHEET  = ../style_template/extra_stylesheet.css \
+                         ../style_template/extra_navtree.css \
+                         ../style_template/extra_search.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
@@ -1381,13 +1381,13 @@ HTML_EXTRA_STYLESHEET  = ../Doxygen_Templates/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       = ../Doxygen_Templates/tabs.css \
-                         ../Doxygen_Templates/version.css \
-                         ../Doxygen_Templates/tab_b.png \
-                         ../Doxygen_Templates/printComponentTabs.js \
-                         ../Doxygen_Templates/darkmode_toggle.js \
-                         ../Doxygen_Templates/navtree.js \
-                         ../Doxygen_Templates/dropdown.png \
+HTML_EXTRA_FILES       = ../style_template/tabs.css \
+                         ../style_template/version.css \
+                         ../style_template/tab_b.png \
+                         ../style_template/printComponentTabs.js \
+                         ../style_template/darkmode_toggle.js \
+                         ../style_template/navtree.js \
+                         ../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.