Skip to content

Commit

Permalink
align doxygen files with CMSIS_RTX
Browse files Browse the repository at this point in the history
  • Loading branch information
GuentherMartin committed Jun 6, 2023
1 parent 940ab75 commit 89fed62
Show file tree
Hide file tree
Showing 11 changed files with 17 additions and 15 deletions.
2 changes: 1 addition & 1 deletion ARM.CMSIS.pdsc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<name>CMSIS</name>
<description>CMSIS (Common Microcontroller Software Interface Standard)</description>
<vendor>ARM</vendor>
<!-- <license>license.txt</license> -->
<license>LICENSE</license>
<url>https://www.keil.com/pack/</url>

<releases>
Expand Down
4 changes: 2 additions & 2 deletions CMSIS/DoxyGen/Core/Core.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -1076,7 +1076,7 @@ EXCLUDE_SYMBOLS =
# that contain example code fragments that are included (see the \include
# command).

EXAMPLE_PATH =
EXAMPLE_PATH =

# If the value of the EXAMPLE_PATH tag contains directories, you can use the
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
Expand Down Expand Up @@ -1414,7 +1414,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \
../Doxygen_Templates/printComponentTabs.js \
../Doxygen_Templates/darkmode_toggle.js \
../Doxygen_Templates/navtree.js \
../Doxygen_Templates/dropdown.png \
../Doxygen_Templates/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
2 changes: 1 addition & 1 deletion CMSIS/DoxyGen/Core_A/Core_A.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -1406,7 +1406,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \
../Doxygen_Templates/printComponentTabs.js \
../Doxygen_Templates/darkmode_toggle.js \
../Doxygen_Templates/navtree.js \
../Doxygen_Templates/dropdown.png \
../Doxygen_Templates/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
2 changes: 1 addition & 1 deletion CMSIS/DoxyGen/Driver/Driver.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -1427,7 +1427,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \
../Doxygen_Templates/printComponentTabs.js \
../Doxygen_Templates/darkmode_toggle.js \
../Doxygen_Templates/navtree.js \
../Doxygen_Templates/dropdown.png \
../Doxygen_Templates/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
2 changes: 1 addition & 1 deletion CMSIS/DoxyGen/General/General.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -1388,7 +1388,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \
../Doxygen_Templates/printComponentTabs.js \
../Doxygen_Templates/darkmode_toggle.js \
../Doxygen_Templates/navtree.js \
../Doxygen_Templates/dropdown.png \
../Doxygen_Templates/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
4 changes: 2 additions & 2 deletions CMSIS/DoxyGen/General/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ with C language standards, specifically warnings that may be generated by the va
License {#License}
=======

CMSIS is provided free of charge by Arm under the <a href="LICENSE.txt">Apache 2.0 License</a>.
CMSIS is provided free of charge by Arm under the <a href="LICENSE">Apache 2.0 License</a>.

CMSIS Software Pack {#CMSIS_Pack}
===================
Expand All @@ -143,7 +143,7 @@ the following:
File/Directory |Content
:------------------|:-------------------
**ARM.CMSIS.pdsc** |Package description file in CMSIS-Pack format.
**LICENSE.txt** |CMSIS License Agreement (Apache 2.0)
**LICENSE** |CMSIS License Agreement (Apache 2.0)
**CMSIS** |\ref cmsis_components "CMSIS components" (see also table below)
**Device** |CMSIS reference implementations of Arm Cortex processor based devices

Expand Down
2 changes: 1 addition & 1 deletion CMSIS/DoxyGen/RTOS2/RTOS2.dxy.in
Original file line number Diff line number Diff line change
Expand Up @@ -1418,7 +1418,7 @@ HTML_EXTRA_FILES = ../Doxygen_Templates/tabs.css \
../Doxygen_Templates/printComponentTabs.js \
../Doxygen_Templates/darkmode_toggle.js \
../Doxygen_Templates/navtree.js \
../Doxygen_Templates/dropdown.png \
../Doxygen_Templates/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
8 changes: 5 additions & 3 deletions CMSIS/DoxyGen/gen_doc.sh
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash
# Version: 2.2
# Date: 2023-05-23
# This bash script generates CMSIS-View documentation
# Version: 2.3
# Date: 2023-06-06
# This bash script generates CMSIS-Core documentation
#
# Pre-requisites:
# - bash shell (for Windows: install git for Windows)
Expand All @@ -11,6 +11,8 @@
set -o pipefail

# Set version of gen pack library
# For available versions see https://github.com/Open-CMSIS-Pack/gen-pack/tags.
# Use the tag name without the prefix "v", e.g., 0.7.0
REQUIRED_GEN_PACK_LIB="0.8.3"

DIRNAME=$(dirname $(readlink -f $0))
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# CMSIS Version 6 - Preview (Work in Progres)

[![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_6)](https://arm-software.github.io/CMSIS_6/General/html/LICENSE.txt)
[![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6)](https://github.com/ARM-software/CMSIS_6/releases/latest) [![License](https://img.shields.io/github/license/arm-software/CMSIS_6)](https://arm-software.github.io/CMSIS_6/General/html/LICENSE)

The branch *main* of this GitHub repository contains ![Version](https://img.shields.io/github/v/release/arm-software/CMSIS_6?display_name=release&label=%20&sort=semver).

Expand Down
4 changes: 2 additions & 2 deletions gen_pack.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
# Version: 2.7
# Date: 2023-05-23
# Date: 2023-06-06
# This bash script generates a CMSIS Software Pack:
#

Expand Down Expand Up @@ -40,7 +40,7 @@ PACK_DIRS="
# Default: empty
#
PACK_BASE_FILES="
LICENSE.txt
LICENSE
"

# Specify file names to be deleted from pack build directory
Expand Down

0 comments on commit 89fed62

Please sign in to comment.