' + this.tabTxt + '';
+ this.listItem = ' ' + this.tabTxt + '';
+};
+
+// array of objects
+var arr = [];
+
+// fill array (not needed in case of a single tab)
+// arr.push( new tabElement( "id", "folderName", "tabTxt"));
+
+// write tabs
+// called from the header file.
+function writeComponentTabs() {
+ for ( var i=0; i < arr.length; i++ ) {
+ str = "/" + arr[i].folderName + "/"
+ if (strgURL.search(str) > 0) { // if this is the current folder
+ document.write(arr[i].currentListItem); // then print and highlight the tab
+ } else {
+ document.write(arr[i].listItem); // else, print the tab
+ }
+ }
+};
diff --git a/DoxyGen/templates/version.css b/Documentation/Doxygen/style_template/version.css
similarity index 93%
rename from DoxyGen/templates/version.css
rename to Documentation/Doxygen/style_template/version.css
index 8013bed..31cc37a 100644
--- a/DoxyGen/templates/version.css
+++ b/Documentation/Doxygen/style_template/version.css
@@ -24,11 +24,6 @@
cursor: pointer;
}
-/* Dropdown button on hover & focus */
-#.dropbtn:hover, .dropbtn:focus {
-# background-size: 0.7em;
-#}
-
/* The container - needed to position the dropdown content */
.dropdown {
position: relative;
diff --git a/Documentation/version.js b/Documentation/version.js
new file mode 100644
index 0000000..884724c
--- /dev/null
+++ b/Documentation/version.js
@@ -0,0 +1 @@
+function writeVersionDropdown() {}
diff --git a/DoxyGen/check_links.sh b/DoxyGen/check_links.sh
deleted file mode 100755
index 2b4fc90..0000000
--- a/DoxyGen/check_links.sh
+++ /dev/null
@@ -1,40 +0,0 @@
-#!/bin/bash
-
-set -o pipefail
-
-DIRNAME=$(dirname $(realpath $0))
-REQUIRED_GEN_PACK_LIB="0.4.0"
-
-############ gen-pack library ###########
-
-function install_lib() {
- local URL="https://github.com/Open-CMSIS-Pack/gen-pack/archive/refs/tags/v$1.tar.gz"
- echo "Downloading gen_pack lib to '$2'"
- mkdir -p "$2"
- curl -L "${URL}" -s | tar -xzf - --strip-components 1 -C "$2" || exit 1
-}
-
-function load_lib() {
- local GLOBAL_LIB="/usr/local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
- local USER_LIB="${HOME}/.local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
- if [[ ! -d "${GLOBAL_LIB}" && ! -d "${USER_LIB}" ]]; then
- echo "Required gen-pack lib not found!" >&2
- install_lib "${REQUIRED_GEN_PACK_LIB}" "${USER_LIB}"
- fi
-
- if [[ -d "${GLOBAL_LIB}" ]]; then
- . "${GLOBAL_LIB}/gen-pack"
- elif [[ -d "${USER_LIB}" ]]; then
- . "${USER_LIB}/gen-pack"
- else
- echo "Required gen-pack lib is not installed!" >&2
- exit 1
- fi
-}
-
-load_lib
-find_linkchecker
-
-#########################################
-
-check_links "${DIRNAME}/../Documentation/index.html" "${DIRNAME}"
diff --git a/DoxyGen/gen_doc.sh b/DoxyGen/gen_doc.sh
deleted file mode 100755
index 7e85f21..0000000
--- a/DoxyGen/gen_doc.sh
+++ /dev/null
@@ -1,106 +0,0 @@
-#!/bin/bash
-# Version: 1.1
-# Date: 2022-11-07
-# This bash script generates CMSIS-Driver Documentation:
-#
-# Pre-requisites:
-# - bash shell (for Windows: install git for Windows)
-# - doxygen 1.9.6
-# - git
-
-set -o pipefail
-
-DIRNAME=$(dirname $(realpath $0))
-DOXYGEN=$(which doxygen)
-REQ_DXY_VERSION="1.9.6"
-REQUIRED_GEN_PACK_LIB="0.6.1"
-
-############ gen-pack library ###########
-
-function install_lib() {
- local URL="https://github.com/Open-CMSIS-Pack/gen-pack/archive/refs/tags/v$1.tar.gz"
- echo "Downloading gen_pack lib to '$2'"
- mkdir -p "$2"
- curl -L "${URL}" -s | tar -xzf - --strip-components 1 -C "$2" || exit 1
-}
-
-function load_lib() {
- if [[ -d ${GEN_PACK_LIB} ]]; then
- . "${GEN_PACK_LIB}/gen-pack"
- return 0
- fi
- local GLOBAL_LIB="/usr/local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
- local USER_LIB="${HOME}/.local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
- if [[ ! -d "${GLOBAL_LIB}" && ! -d "${USER_LIB}" ]]; then
- echo "Required gen-pack lib not found!" >&2
- install_lib "${REQUIRED_GEN_PACK_LIB}" "${USER_LIB}"
- fi
-
- if [[ -d "${GLOBAL_LIB}" ]]; then
- . "${GLOBAL_LIB}/gen-pack"
- elif [[ -d "${USER_LIB}" ]]; then
- . "${USER_LIB}/gen-pack"
- else
- echo "Required gen-pack lib is not installed!" >&2
- exit 1
- fi
-}
-
-load_lib
-find_git
-
-#########################################
-
-if [[ ! -f "${DOXYGEN}" ]]; then
- echo "Doxygen not found!" >&2
- echo "Did you miss to add it to PATH?"
- exit 1
-else
- version=$("${DOXYGEN}" --version | sed -E 's/.*([0-9]+\.[0-9]+\.[0-9]+).*/\1/')
- echo "DOXYGEN is ${DOXYGEN} at version ${version}"
- if [[ "${version}" != "${REQ_DXY_VERSION}" ]]; then
- echo " >> Version is different from ${REQ_DXY_VERSION} !" >&2
- fi
-fi
-
-if [ -z "$VERSION" ]; then
- VERSION_FULL=$(git_describe)
- VERSION=${VERSION_FULL%+*}
-else
- VERSION_FULL=${VERSION}
-fi
-
-echo "Generating documentation ..."
-
-pushd $DIRNAME > /dev/null
-
-rm -rf ${DIRNAME}/../Documentation/html
-sed -e "s/{projectNumber}/${VERSION}/" "${DIRNAME}/CMSIS_DV.dxy.in" \
- > "${DIRNAME}/CMSIS_DV.dxy"
-
-PACK_CHANGELOG_MODE="tag"
-DEV=$(pdsc_release_desc "${DIRNAME}/../ARM.CMSIS-Driver_Validation.pdsc")
-git_changelog -f html -d "${DEV}" > src/history.txt
-
-echo "${DOXYGEN} CMSIS_DV.dxy"
-"${DOXYGEN}" CMSIS_DV.dxy
-popd > /dev/null
-
-if [[ $2 != 0 ]]; then
- cp -f "${DIRNAME}/templates/search.css" "${DIRNAME}/../Documentation/html/search/"
-fi
-
-projectName=$(grep -E "PROJECT_NAME\s+=" "${DIRNAME}/CMSIS_DV.dxy" | sed -r -e 's/[^"]*"([^"]+)"/\1/')
-datetime=$(date -u +'%a %b %e %Y %H:%M:%S')
-year=$(date -u +'%Y')
-if [[ "${year}" != "2022" ]]; then
- year="2022-${year}"
-fi
-sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/templates/footer.js.in" \
- | sed -e "s/{year}/${year}/" \
- | sed -e "s/{projectName}/${projectName}/" \
- | sed -e "s/{projectNumber}/${VERSION}/" \
- | sed -e "s/{projectNumberFull}/${VERSION_FULL}/" \
- > "${DIRNAME}/../Documentation/html/footer.js"
-
-exit 0
\ No newline at end of file
diff --git a/DoxyGen/templates/extra_stylesheet.css b/DoxyGen/templates/extra_stylesheet.css
deleted file mode 100644
index 52d3123..0000000
--- a/DoxyGen/templates/extra_stylesheet.css
+++ /dev/null
@@ -1,1414 +0,0 @@
-/* The standard CSS for doxygen */
-:root {
- --arm_light_blue: #00C1DE;
- --arm_blue: #11809F;
- --arm_blue1: #0091BD;
- --arm_dark_blue: #002B49;
- --arm_light_gray: #E5ECEB;
- --arm_light_gray1: #EFF5F4;
- --arm_light_gray2: #EBEBEB;
- --arm_light_gray3: #F7F7F7;
- --arm_dark_gray: #7D868C;
- --arm_black: #333E48;
- --arm_orange: #FF6B00;
-}
-
-body, table, div, p, dl {
- font-family: Lato, Calibri, sans-serif;
- font-size: 16px;
- line-height: 22px;
-}
-
-/* styles */
-
-.style1 {
- text-align: center;
-}
-.style2 {
- color: var(--arm_blue);
- font-weight: normal;
-}
-.style3 {
- text-align: left;
-}
-.style4 {
- color: #008000;
-}
-.style5 {
- color: #0000FF;
-}
-.style6 {
- color: #000000;
- font-style:italic;
-}
-.mand {
- color: #0000FF;
-}
-.opt {
- color: #008000;
-}
-.cond {
- color: var(--arm_orange);
-}
-
-.choice
-{
- background-color:#F7F9D0;
-}
-.seq
-{
- background-color:#C9DECB;
-}
-.group1
-{
- background-color:#F8F1F1;
-}
-.group2
-{
- background-color:#DCEDEA;
-}
-
-.arrow {
- color: var(--arm_blue);
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
- cursor: pointer;
- font-size: 100%;
- width: 16px;
- height: 22px;
- display: inline-block;
-}
-
-.main-menu {
- margin: 0;
- padding: 0;
- display: table;
- line-height: 24px;
-}
-
-ul {
- list-style-type: disc;
- padding-left: 2em;
- margin-block-start: 0em;
-}
-
-li {
- margin-top: 0.25em;
- line-height: 24px;
-}
-
-ul ul {
- list-style-type: circle;
-}
-
-ul ul ul {
- list-style-type: square;
-}
-
-ul.hierarchy {
- color: green;
-}
-
-em {
- font-style:italic;
-}
-
-code {
- font-family: monospace;
- font-size: 85%;
- line-height: 1.6;
- background-color: var(--arm_light_gray2);
- border-radius: 6px;
- padding: 0.2em 0.4em;
-}
-
-/* Tables */
-table.cmtab1 {
- padding: 4px;
- border-collapse: collapse;
- border: 1px solid var(--arm_dark_gray);
- text-align: justify;
- width:70%;
-}
-
-th.cmtab1 {
- background: var(--arm_light_gray3);
- font-weight: bold;
- height: 28px;
-}
-
-td.cmtab1 {
- padding:1px;
- text-align: left;
-}
-
-table.cmtable {
- border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
-}
-
-table.cmtable td, table.cmtable th {
- border: 1px solid var(--arm_light_gray);
- padding: 7px 10px 5px;
- text-align:left;
-}
-
-table.cmtable th {
- background-color: var(--arm_blue);
- color: white;
-}
-
-table.cmtable tr:nth-child(even) {
- background-color: var(--arm_light_gray3);
-}
-
-td.MonoTxt {
- font-family:"Arial monospaced for SAP";
-}
-
-td.XML-Token
-{
- azimuth: 180;
- font-style:italic;
- color:Maroon;
- z-index:20;
-}
-
-span.XML-Token
-{
- azimuth: 180;
- font-style:italic;
- color:Maroon;
- z-index:20;
-}
-
-span.h2
-{
- font-size: 120%;
- font-weight: bold;
-}
-
-div.new
-{
- background-color:#ccffcc; /* light green */
-}
-
-div.mod
-{
- background-color:#ffe6cc; /* light amber */
-}
-
-div.del
-{
- background-color:#ffcccc; /* light red */
-}
-
-/* @group Heading Levels */
-
-h1 {
- font-size: 150%;
- border-top-color: var(--arm_light_gray3);
- border-top-width: 2px;
- border-top-style: solid;
- padding: 1em 0 0;
- margin-top: 0.5em;
- margin-bottom: 0.75em;
-}
-/*
-h1:before {
- margin-bottom: 1em;
- content: "";
- background-color: var(--arm_light_gray3);
- height: 2px;
- display: block;
- width: 100%;
-}
-*/
-.title {
- font-size: 150%;
- font-weight: bold;
- margin: 10px 2px;
-}
-
-h2 {
- font-size: 120%;
- margin-top: 1.25em;
- margin-bottom: 0.25em;
-}
-
-h3 {
- font-size: 100%;
- margin-top: 1.25em;
- margin-bottom: 0.25em;
-}
-
-h4 {
- font-size: 100%;
- color: #505050;
-}
-
-h1, h2, h3, h4, h5, h6 {
- -webkit-transition: text-shadow 0.5s linear;
- -moz-transition: text-shadow 0.5s linear;
- -ms-transition: text-shadow 0.5s linear;
- -o-transition: text-shadow 0.5s linear;
- transition: text-shadow 0.5s linear;
- margin-right: 15px;
-}
-
-h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
- text-shadow: 0 0 15px cyan;
-}
-
-dt {
- font-weight: bold;
-}
-
-div.multicol {
- -moz-column-gap: 1em;
- -webkit-column-gap: 1em;
- -moz-column-count: 3;
- -webkit-column-count: 3;
-}
-
-p {
- margin-block-start: 1em;
- margin-block-end: 0.5em;
-}
-
-p.startli, p.startdd, p.starttd {
- margin-top: 2px;
-}
-
-p.endli {
- margin-bottom: 0px;
-}
-
-p.enddd {
- margin-bottom: 4px;
-}
-
-p.endtd {
- margin-bottom: 2px;
-}
-
-/* @end */
-
-caption {
- font-weight: bold;
-}
-
-span.legend {
- font-size: 70%;
- text-align: center;
-}
-
-h3.version {
- font-size: 90%;
- text-align: center;
-}
-
-div.qindex, div.navtab{
- background-color: #EBEFF6;
- border: 1px solid #A2B4D8;
- text-align: center;
-}
-
-div.qindex, div.navpath {
- width: 100%;
- line-height: 140%;
-}
-
-div.navtab {
- margin-right: 15px;
-}
-
-/* @group Link Styling */
-
-a {
- color: var(--arm_blue);
- text-decoration: none;
-}
-
-.contents a:visited {
- color: var(--arm_blue);
-}
-
-a:hover {
- text-decoration: underline;
-}
-
-a.qindex {
- font-weight: bold;
-}
-
-a.qindexHL {
- font-weight: bold;
- background-color: #9AAED5;
- color: #ffffff;
- border: 1px double #849CCC;
-}
-
-.contents a.qindexHL:visited {
- color: #ffffff;
-}
-
-a.el {
- font-weight: bold;
-}
-
-a.elRef {
-}
-
-a.code, a.code:visited {
- color: #4665A2;
-}
-
-a.codeRef, a.codeRef:visited {
- color: #4665A2;
-}
-
-/* @end */
-
-dl.el {
- margin-left: -1cm;
-}
-
-
-pre.fragment {
- font-family: monospace;
- background-color: var(--arm_light_gray2);
- border-radius: 6px;
- padding: 0.2em 0.4em;
- font-size: 85%;
- line-height: 1.45;
- margin: 0.5em 0px;
-}
-
-div.fragment {
- font-family: monospace;
- background-color: var(--arm_light_gray2);
- border-radius: 6px;
- padding: 0.2em 0.4em;
- font-size: 85%;
- line-height: 1.45;
-}
-
-div.line {
- font-family: monospace;
- font-size: 100%;
- line-height: 1.45;
- text-wrap: unrestricted;
- white-space: -moz-pre-wrap; /* Moz */
- white-space: -pre-wrap; /* Opera 4-6 */
- white-space: -o-pre-wrap; /* Opera 7 */
- white-space: pre-wrap; /* CSS3 */
- word-wrap: break-word; /* IE 5.5+ */
- text-indent: -53px;
- padding-left: 53px;
- padding-bottom: 0px;
- margin: 0px;
-}
-
-span.lineno {
- padding-right: 4px;
- text-align: right;
- border-right: 2px solid #0F0;
- background-color: #E8E8E8;
- white-space: pre;
-}
-span.lineno a {
- background-color: #D8D8D8;
-}
-
-span.lineno a:hover {
- background-color: #C8C8C8;
-}
-
-div.ah {
- background-color: black;
- font-weight: bold;
- color: #ffffff;
- margin-bottom: 3px;
- margin-top: 3px;
- padding: 0.2em;
- border: solid thin #333;
- border-radius: 0.5em;
- -webkit-border-radius: .5em;
- -moz-border-radius: .5em;
-}
-
-div.groupHeader {
- margin-left: 16px;
- margin-top: 12px;
- font-weight: bold;
-}
-
-div.groupText {
- margin-left: 16px;
- font-style: italic;
-}
-
-body {
- background-color: white;
- color: black;
- margin: 0;
-}
-
-div.contents {
- margin-top: 10px;
- margin-left: 12px;
- margin-right: 8px;
-}
-
-td.indexkey {
- background-color: #EBEFF6;
- font-weight: bold;
- border: 1px solid #C3CFE6;
- margin: 2px 0px 2px 0;
- padding: 2px 10px;
- white-space: nowrap;
- vertical-align: top;
-}
-
-td.indexvalue {
- background-color: #EBEFF6;
- border: 1px solid #C3CFE6;
- padding: 2px 10px;
- margin: 2px 0px;
-}
-
-tr.memlist {
- background-color: #EDF1F7;
-}
-
-p.formulaDsp {
- text-align: center;
-}
-
-img.formulaDsp {
-
-}
-
-img.formulaInl {
- vertical-align: middle;
-}
-
-div.center {
- text-align: center;
- margin-top: 0px;
- margin-bottom: 0px;
- padding: 0px;
-}
-
-div.center img {
- border: 0px;
-}
-
-address.footer {
- text-align: right;
- padding-right: 12px;
-}
-
-img.footer {
- border: 0px;
- vertical-align: middle;
-}
-
-/* @group Code Colorization */
-
-span.keyword {
- color: #008000
-}
-
-span.keywordtype {
- color: #604020
-}
-
-span.keywordflow {
- color: #e08000
-}
-
-span.comment {
- color: #800000
-}
-
-span.preprocessor {
- color: #806020
-}
-
-span.stringliteral {
- color: #002080
-}
-
-span.charliteral {
- color: #008080
-}
-
-span.vhdldigit {
- color: #ff00ff
-}
-
-span.vhdlchar {
- color: #000000
-}
-
-span.vhdlkeyword {
- color: #700070
-}
-
-span.vhdllogic {
- color: #ff0000
-}
-
-blockquote {
- background-color: #F7F8FB;
- border-left: 2px solid #9AAED5;
- margin: 0 24px 0 4px;
- padding: 0 12px 0 16px;
-}
-
-/* @end */
-
-/*
-.search {
- color: #003399;
- font-weight: bold;
-}
-
-form.search {
- margin-bottom: 0px;
- margin-top: 0px;
-}
-
-input.search {
- font-size: 75%;
- color: #000080;
- font-weight: normal;
- background-color: #e8eef2;
-}
-*/
-
-td.tiny {
- font-size: 75%;
-}
-
-.dirtab {
- padding: 4px;
- border-collapse: collapse;
- border: 1px solid #A2B4D8;
-}
-
-th.dirtab {
- background: #EBEFF6;
- font-weight: bold;
-}
-
-hr {
- height: 0px;
- border: none;
- border-top: 1px solid #4769AD;
-}
-
-hr.footer {
- height: 1px;
-}
-
-/* @group Member Descriptions */
-
-table.memberdecls {
- border-spacing: 0px;
- padding: 0px;
-}
-
-.memberdecls td {
- -webkit-transition-property: background-color, box-shadow;
- -webkit-transition-duration: 0.5s;
- -moz-transition-property: background-color, box-shadow;
- -moz-transition-duration: 0.5s;
- -ms-transition-property: background-color, box-shadow;
- -ms-transition-duration: 0.5s;
- -o-transition-property: background-color, box-shadow;
- -o-transition-duration: 0.5s;
- transition-property: background-color, box-shadow;
- transition-duration: 0.5s;
-}
-
-.memberdecls td.glow {
- background-color: cyan;
- /*box-shadow: 0 0 15px cyan; */
-}
-
-.mdescLeft, .mdescRight,
-.memItemLeft, .memItemRight,
-.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
- background-color: #F9FAFC;
- border: none;
- margin: 4px;
- padding: 1px 0 0 8px;
-}
-
-.mdescLeft, .mdescRight {
- padding: 0px 8px 4px 8px;
- color: #555;
-}
-
-.memItemLeft, .memItemRight, .memTemplParams {
- border-top: 1px solid var(--arm_light_gray);/*#C3CFE6;*/
-}
-
-.memItemLeft, .memTemplItemLeft {
- white-space: nowrap;
-}
-
-.memItemRight {
- width: 100%;
-}
-
-.memTemplParams {
- color: #4464A5;
- white-space: nowrap;
-}
-
-/* @end */
-
-/* @group Member Details */
-
-/* Styles for detailed member documentation */
-
-.memtitle {
- display: inline-block;
- padding: 8px;
- padding-bottom: 12px;
- padding-right: 12px;
- border-top: 1px solid var(--arm_dark_gray);
- border-left: 1px solid var(--arm_dark_gray);
- border-right: 1px solid var(--arm_dark_gray);
- border-top-right-radius: 4px;
- border-top-left-radius: 4px;
- margin-bottom: -1px;
- background-color: var(--arm_light_gray2);
- line-height: 1.25;
- font-weight: 600;
- float:top;
-}
-
-.permalink
-{
- font-size: 100%;
- display: inline-block;
- vertical-align: middle;
- padding-bottom:6px;
-}
-
-.memtemplate {
- font-size: 80%;
- color: #4464A5;
- font-weight: normal;
- margin-left: 9px;
-}
-
-.memnav {
- background-color: #EBEFF6;
- border: 1px solid #A2B4D8;
- text-align: center;
- margin: 2px;
- margin-right: 15px;
- padding: 2px;
-}
-
-.mempage {
- width: 100%;
-}
-
-.memitem {
- padding: 0;
- margin-bottom: 10px;
- margin-right: 5px;
- -webkit-transition: box-shadow 0.5s linear;
- -moz-transition: box-shadow 0.5s linear;
- -ms-transition: box-shadow 0.5s linear;
- -o-transition: box-shadow 0.5s linear;
- transition: box-shadow 0.5s linear;
-}
-
-.memitem.glow {
- /*box-shadow: 0 0 15px cyan; */
-}
-
-.memname {
- font-weight: bold;
- margin-left: 6px;
-}
-
-.memname td {
- vertical-align: bottom;
-}
-
-.memproto, dl.reflist dt {
- border-top: 1px solid var(--arm_dark_gray);
- border-left: 1px solid var(--arm_dark_gray);
- border-right: 1px solid var(--arm_dark_gray);
- padding: 6px 0px 6px 0px;
- color: var(--arm_black);
- font-weight: bold;
- background-color: var(--arm_light_gray2);
- border-top-right-radius: 4px;
- border-top-left-radius: 0px;
- /* firefox specific markup */
- -moz-border-radius-topright: 4px;
- -moz-border-radius-topleft: 0px;
- /* webkit specific markup */
- -webkit-border-top-right-radius: 4px;
- -webkit-border-top-left-radius: 0px;
-}
-
-.memdoc, dl.reflist dd {
- border: 1px solid var(--arm_dark_gray);
- padding: 6px 10px 2px 10px;
- background-color: #FFFFFF;
- /* opera specific markup */
- border-bottom-left-radius: 4px;
- border-bottom-right-radius: 4px;
- /* firefox specific markup */
- -moz-border-radius-bottomleft: 4px;
- -moz-border-radius-bottomright: 4px;
- /* webkit specific markup */
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
-}
-
-dl.reflist dt {
- padding: 5px;
-}
-
-dl.reflist dd {
- margin: 0px 0px 10px 0px;
- padding: 5px;
-}
-
-.paramkey {
- text-align: right;
-}
-
-.paramtype {
- white-space: nowrap;
-}
-
-.paramname {
- color: #602020;
- white-space: nowrap;
-}
-.paramname em {
- font-style: normal;
-}
-
-.params, .retval, .exception, .tparams {
- margin-left: 0px;
- padding-left: 0px;
-}
-
-.params .paramname, .retval .paramname {
- font-weight: bold;
- vertical-align: top;
-}
-
-.params .paramtype {
- font-style: italic;
- vertical-align: top;
-}
-
-.params .paramdir {
- font-family: "courier new",courier,monospace;
- vertical-align: top;
-}
-
-table.mlabels {
- border-spacing: 0px;
-}
-
-td.mlabels-left {
- width: 100%;
- padding: 0px;
-}
-
-td.mlabels-right {
- vertical-align: bottom;
- padding: 0px;
- white-space: nowrap;
-}
-
-span.mlabels {
- margin-left: 8px;
-}
-
-span.mlabel {
- background-color: #708CC4;
- border-top:1px solid #5072B7;
- border-left:1px solid #5072B7;
- border-right:1px solid #C3CFE6;
- border-bottom:1px solid #C3CFE6;
- text-shadow: none;
- color: white;
- margin-right: 4px;
- padding: 2px 3px;
- border-radius: 3px;
- font-size: 7pt;
- white-space: nowrap;
-}
-
-
-
-/* @end */
-
-/* these are for tree view when not used as main index */
-
-div.directory {
- margin: 10px 0px;
- border-top: 1px solid var(--arm_dark_gray);
- border-bottom: 1px solid var(--arm_dark_gray);
- width: 100%;
-}
-
-.directory table {
- border-collapse:collapse;
-}
-
-.directory td {
- margin: 0px;
- padding: 0px 0px 15px 0px;
- vertical-align: top;
-}
-
-.directory td.entry {
- white-space: nowrap;
- padding-right: 6px;
-}
-
-.directory td.entry a {
- outline:none;
- padding-left: 6px;
-}
-
-.directory td.desc {
- width: 100%;
- padding-left: 6px;
- padding-right: 6px;
- border-left: 1px solid rgba(0,0,0,0.05);
-}
-
-.directory tr.even {
- padding-left: 6px;
- background-color: #F7F8FB;
-}
-
-.directory img {
- vertical-align: -30%;
-}
-
-.directory .levels {
- white-space: nowrap;
- width: 100%;
- text-align: right;
- font-size: 9pt;
-}
-
-.directory .levels span {
- cursor: pointer;
- padding-left: 2px;
- padding-right: 2px;
- color: #3A568E;
-}
-
-div.dynheader {
- margin-top: 8px;
- -webkit-touch-callout: none;
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
-}
-
-address {
- font-style: normal;
- color: #293C63;
-}
-
-table.doxtable {
- border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
-}
-
-table.doxtable td, table.doxtable th {
- border: 1px solid var(--arm_light_gray);
- padding: 7px 10px 5px;
- text-align:left;
-}
-
-table.doxtable th {
- background-color: var(--arm_blue);
- color: white;
-}
-
-table.doxtable tr:nth-child(even) {
- background-color: #F9FAFC; /*var(--arm_light_gray3); */
-}
-
-table.fieldtable {
- width: 100%;
- margin-bottom: 10px;
- border: 1px solid var(--arm_dark_gray);
- border-spacing: 0px;
- -moz-border-radius: 4px;
- -webkit-border-radius: 4px;
- border-radius: 4px;
-}
-
-.fieldtable td, .fieldtable th {
- padding: 3px 7px 2px;
-}
-
-.fieldtable td.fieldtype, .fieldtable td.fieldname, td.fieldoc{
- white-space: nowrap;
- border-right: 1px solid var(--arm_dark_gray);
- border-bottom: 1px solid var(--arm_dark_gray);
- vertical-align: top;
-}
-
-.fieldtable td.fielddoc {
- border-bottom: 1px solid var(--arm_dark_gray);
- width: 100%;
-}
-
-.fieldtable td.fielddoc p {
- margin-top: 0px;
-}
-
-.fieldtable tr:last-child td {
- border-bottom: none;
-}
-
-.fieldtable th {
- background-color: var(--arm_light_gray1);
- font-size: 100%;
- color: var(--arm_black);
- padding-bottom: 4px;
- padding-top: 5px;
- text-align:left;
- -moz-border-radius-topleft: 4px;
- -moz-border-radius-topright: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- border-top-left-radius: 4px;
- border-top-right-radius: 4px;
- border-bottom: 1px solid var(--arm_dark_gray);
-}
-
-
-/* @group Markdown */
-
-table.markdownTable {
- border-collapse:collapse;
- margin-top: 4px;
- margin-bottom: 4px;
-}
-
-table.markdownTable td, table.markdownTable th {
- border: 1px solid var(--arm_light_gray);
- padding: 7px 10px 5px;
- text-align:left;
-}
-
-table.markdownTable th {
- background-color: var(--arm_blue);
- color: white;
-}
-
-table.markdownTable tr:nth-child(even) {
- background-color: var(--arm_light_gray3);
-}
-
-/* for hyperlinks in table head rows */
-table.markdownTable th a{
- color: white;
- text-decoration: underline;
-}
-
-table.markdownTable th a:visited{
- color: white;
-}
-
-table.markdownTable th a:hover{
- color: var(--arm_yellow);
-}
-
-/* @end */
-
-
-.tabsearch {
- top: 0px;
- left: 10px;
- height: 36px;
- background-image: url('tab_b.png');
- z-index: 101;
- overflow: hidden;
- font-size: 13px;
-}
-
-.navpath ul
-{
- font-size: 11px;
- background-color:var(--arm_black);
- height:30px;
- line-height:30px;
- color:white;
- border:solid 1px #C1CDE5;
- overflow:hidden;
- margin:0px;
- padding:0px;
-}
-
-.navpath li
-{
- list-style-type:none;
- float:left;
- padding-left:10px;
- padding-right:15px;
- color:#344D7E;
-}
-
-.navpath li.navelem a
-{
- height:32px;
- display:block;
- text-decoration: none;
- outline: none;
-}
-
-.navpath li.navelem a:hover
-{
- color:#6583BF;
-}
-
-.navpath li.footer
-{
- list-style-type:none;
- float:right;
- padding-left:10px;
- padding-right:15px;
- color:var(--arm_white);
- font-size: 8pt;
-}
-
-div.summary
-{
- float: right;
- font-size: 8pt;
- padding-right: 5px;
- width: 50%;
- text-align: right;
-}
-
-div.summary a
-{
- white-space: nowrap;
-}
-
-div.ingroups
-{
- margin-left: 5px;
- font-size: 8pt;
- padding-left: 5px;
- width: 50%;
- text-align: left;
-}
-
-div.ingroups a
-{
- white-space: nowrap;
-}
-
-div.header
-{
- background-color: white;
- margin: 0px;
-}
-
-div.headertitle
-{
- padding: 5px 5px 5px 7px;
-}
-
-dl
-{
- padding: 0 0 0 10px;
-}
-
-/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
-dl.section
-{
- margin-left: 0px;
- padding-left: 0px;
-}
-
-dl.note
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #D0C000;
-}
-
-dl.warning, dl.attention
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #FF0000;
-}
-
-dl.pre, dl.post, dl.invariant
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #00D000;
-}
-
-dl.deprecated
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #505050;
-}
-
-dl.todo
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #00C0E0;
-}
-
-dl.test
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #3030E0;
-}
-
-dl.bug
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #C08050;
-}
-
-dl.safety
-{
- margin-left:-7px;
- padding-left: 3px;
- border-left:4px solid;
- border-color: #008000;
-}
-
-
-dl.section dd {
- margin-bottom: 6px;
-}
-
-
-#projectlogo
-{
- text-align: center;
- vertical-align: middle;
- border-collapse: separate;
-}
-
-#projectlogo img
-{
- border: 0px none;
-}
-
-#projectname
-{
- font: 270% 'Lato Lite', Lato, Caibri, sans-serif;
- font-weight: 600;
- margin: 0px;
- color: white;
- padding: 2px 0px;
-}
-
-#projectbrief
-{
- font: 140% "Lato Lite", Lato, Caibri, sans-serif;
- margin: 0px;
- color: white;
- padding: 4px 0px 4px;
-}
-
-#projectnumber
-{
- font: 50% "Lato Lite", Lato, Caibri, sans-serif;
- margin: 0px;
- color: white;
- padding: 0px;
-}
-
-#titlearea
-{
- padding: 0px;
- margin: 0px;
- width: 100%;
- border-bottom: 1px solid var(--arm_dark_gray);
- background-color: var(--arm_black);
-}
-
-.image
-{
- text-align: left;
- display: grid;
- justify-content: start;
- align-items: baseline;
- justify-items: center;
-}
-
-.dotgraph
-{
- text-align: center;
-}
-
-.mscgraph
-{
- text-align: center;
-}
-
-.caption
-{
- font-weight: bold;
- font-size: 80%;
-}
-
-div.zoom
-{
- border: 1px solid #8EA4D0;
-}
-
-dl.citelist {
- margin-bottom:50px;
-}
-
-dl.citelist dt {
- color:#314877;
- float:left;
- font-weight:bold;
- margin-right:10px;
- padding:5px;
-}
-
-dl.citelist dd {
- margin:2px 0;
- padding:5px 0;
-}
-
-div.toc {
- padding: 14px 25px;
- background-color: #F4F6FA;
- border: 1px solid #D7DFEE;
- border-radius: 7px 7px 7px 7px;
- float: right;
- height: auto;
- margin: 0 20px 10px 10px;
- width: 200px;
-}
-
-div.toc li {
- background: url("bdwn.png") no-repeat scroll 0 5px transparent;
- font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
- margin-top: 5px;
- padding-left: 10px;
- padding-top: 2px;
-}
-
-div.toc h3 {
- font: bold 12px/1.2 Arial,FreeSans,sans-serif;
- color: #4464A5;
- border-bottom: 0 none;
- margin: 0;
-}
-
-div.toc ul {
- list-style: none outside none;
- border: medium none;
- padding: 0px;
-}
-
-div.toc li.level1 {
- margin-left: 0px;
-}
-
-div.toc li.level2 {
- margin-left: 15px;
-}
-
-div.toc li.level3 {
- margin-left: 30px;
-}
-
-div.toc li.level4 {
- margin-left: 45px;
-}
-
-.inherit_header {
- font-weight: bold;
- color: gray;
- cursor: pointer;
- -webkit-touch-callout: none;
- -webkit-user-select: none;
- -khtml-user-select: none;
- -moz-user-select: none;
- -ms-user-select: none;
- user-select: none;
-}
-
-.inherit_header td {
- padding: 6px 0px 2px 5px;
-}
-
-.inherit {
- display: none;
-}
-
-tr.heading h2 {
- margin-top: 12px;
- margin-bottom: 4px;
-}
-
-@media print
-{
- #top { display: none; }
- #side-nav { display: none; }
- #nav-path { display: none; }
- body { overflow:visible; }
- h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
- .summary { display: none; }
- .memitem { page-break-inside: avoid; }
- #doc-content
- {
- margin-left:0 !important;
- height:auto !important;
- width:auto !important;
- overflow:inherit;
- display:inline;
- }
-}
-
diff --git a/DoxyGen/templates/search.css b/DoxyGen/templates/search.css
deleted file mode 100644
index da3b509..0000000
--- a/DoxyGen/templates/search.css
+++ /dev/null
@@ -1,240 +0,0 @@
-/*---------------- Search Box */
-
-#FSearchBox {
- float: left;
-}
-
-#searchli {
- float: right;
- display: block;
- width: 170px;
- height: 24px;
-}
-
-#MSearchBox {
- white-space : nowrap;
- position: absolute;
- float: none;
- display: inline;
- margin-top: 3px;
- right: 0px;
- width: 170px;
- z-index: 102;
-}
-
-#MSearchBox .left
-{
- display:block;
- position:absolute;
- left:10px;
- width:20px;
- height:19px;
- background:url('search_l.png') no-repeat;
- background-position:right;
-}
-
-#MSearchSelect {
- display:block;
- position:absolute;
- width:20px;
- height:19px;
-}
-
-.left #MSearchSelect {
- left:4px;
-}
-
-.right #MSearchSelect {
- right:5px;
-}
-
-#MSearchField {
- display:block;
- position:absolute;
- height:19px;
- background:url('search_m.png') repeat-x;
- border:none;
- width:116px;
- margin-left:20px;
- padding-left:4px;
- color: #909090;
- outline: none;
- font: 9pt Arial, Verdana, sans-serif;
-}
-
-#FSearchBox #MSearchField {
- margin-left:15px;
-}
-
-#MSearchBox .right {
- display:block;
- position:absolute;
- right:10px;
- top:0px;
- width:20px;
- height:19px;
- background:url('search_r.png') no-repeat;
- background-position:left;
-}
-
-#MSearchClose {
- display: none;
- position: absolute;
- top: 4px;
- background : none;
- border: none;
- margin: 0px 4px 0px 0px;
- padding: 0px 0px;
- outline: none;
-}
-
-.left #MSearchClose {
- left: 6px;
-}
-
-.right #MSearchClose {
- right: 2px;
-}
-
-.MSearchBoxActive #MSearchField {
- color: #000000;
-}
-
-/*---------------- Search filter selection */
-
-#MSearchSelectWindow {
- display: none;
- position: absolute;
- left: 0; top: 0;
- border: 1px solid #90A5CE;
- background-color: #F9FAFC;
- z-index: 1;
- padding-top: 4px;
- padding-bottom: 4px;
- -moz-border-radius: 4px;
- -webkit-border-top-left-radius: 4px;
- -webkit-border-top-right-radius: 4px;
- -webkit-border-bottom-left-radius: 4px;
- -webkit-border-bottom-right-radius: 4px;
- -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-}
-
-.SelectItem {
- font: 8pt Arial, Verdana, sans-serif;
- padding-left: 2px;
- padding-right: 12px;
- border: 0px;
-}
-
-span.SelectionMark {
- margin-right: 4px;
- font-family: monospace;
- outline-style: none;
- text-decoration: none;
-}
-
-a.SelectItem {
- display: block;
- outline-style: none;
- color: #000000;
- text-decoration: none;
- padding-left: 6px;
- padding-right: 12px;
-}
-
-a.SelectItem:focus,
-a.SelectItem:active {
- color: #000000;
- outline-style: none;
- text-decoration: none;
-}
-
-a.SelectItem:hover {
- color: #FFFFFF;
- background-color: #3D578C;
- outline-style: none;
- text-decoration: none;
- cursor: pointer;
- display: block;
-}
-
-/*---------------- Search results window */
-
-iframe#MSearchResults {
- width: 60ex;
- height: 15em;
-}
-
-#MSearchResultsWindow {
- display: none;
- position: absolute;
- left: 0; top: 0;
- border: 1px solid #000;
- background-color: #EEF1F7;
-}
-
-/* ----------------------------------- */
-
-
-#SRIndex {
- clear:both;
- padding-bottom: 15px;
-}
-
-.SREntry {
- font-size: 10pt;
- padding-left: 1ex;
-}
-
-.SRPage .SREntry {
- font-size: 8pt;
- padding: 1px 5px;
-}
-
-body.SRPage {
- margin: 5px 2px;
-}
-
-.SRChildren {
- padding-left: 3ex; padding-bottom: .5em
-}
-
-.SRPage .SRChildren {
- display: none;
-}
-
-.SRSymbol {
- font-weight: bold;
- color: #425E97;
- font-family: Arial, Verdana, sans-serif;
- text-decoration: none;
- outline: none;
-}
-
-a.SRScope {
- display: block;
- color: #425E97;
- font-family: Arial, Verdana, sans-serif;
- text-decoration: none;
- outline: none;
-}
-
-a.SRSymbol:focus, a.SRSymbol:active,
-a.SRScope:focus, a.SRScope:active {
- text-decoration: underline;
-}
-
-.SRPage .SRStatus {
- padding: 2px 5px;
- font-size: 8pt;
- font-style: italic;
-}
-
-.SRResult {
- display: none;
-}
-
-DIV.searchresults {
- margin-left: 10px;
- margin-right: 10px;
-}
diff --git a/gen_pack.sh b/gen_pack.sh
index 50c3df1..5ed65c2 100755
--- a/gen_pack.sh
+++ b/gen_pack.sh
@@ -1,24 +1,33 @@
-#!/bin/bash
-# Version: 2.3
-# Date: 2022-09-28
-# This bash script generates a CMSIS-Driver Software Pack
+#!/usr/bin/env bash
+# Version: 3.1
+# Date: 2024-04-17
+# This bash script generates a CMSIS Software Pack: CMSIS-Driver_Validation
#
set -o pipefail
# Set version of gen pack library
-REQUIRED_GEN_PACK_LIB="0.6.1"
+# 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.11.3"
# Set default command line arguments
DEFAULT_ARGS=(-c "")
# Pack warehouse directory - destination
-PACK_OUTPUT=./output
+# Default: ./output
+#
+# PACK_OUTPUT=./output
# Temporary pack build directory
-PACK_BUILD=./build
+# Default: ./build
+#
+# PACK_BUILD=./build
# Specify directory names to be added to pack base directory
+# An empty list defaults to all folders next to this script.
+# Default: empty (all folders)
+#
PACK_DIRS="
Boards
Config
@@ -29,21 +38,35 @@ PACK_DIRS="
"
# Specify file names to be added to pack base directory
+# Default: empty
+#
PACK_BASE_FILES="
LICENSE.txt
README.md
"
# Specify file names to be deleted from pack build directory
-PACK_DELETE_FILES=""
+# Default: empty
+#
+PACK_DELETE_FILES="
+ Documentation/Doxygen
+"
# Specify patches to be applied
-PACK_PATCH_FILES=""
+# Default: empty
+#
+# PACK_PATCH_FILES="
+#
+# "
# Specify addition argument to packchk
-PACKCHK_ARGS=()
+# Default: empty
+#
+# PACKCHK_ARGS=()
# Specify additional dependencies for packchk
+# Default: empty
+#
PACKCHK_DEPS="
ARM.CMSIS.pdsc
ARM.CMSIS-RTX.pdsc
@@ -62,49 +85,63 @@ PACKCHK_DEPS="
# - full Tag annotations, release descriptions, or commit messages (in order)
# - release Tag annotations, or release descriptions (in order)
# - tag Tag annotations only
+#
PACK_CHANGELOG_MODE="tag"
+# Specify file patterns to be excluded from the checksum file
+# Default:
+# Values:
+# - empty All files packaged are included in the checksum file
+# - glob pattern One glob pattern per line. Files matching a given pattern are excluded
+# from the checksum file
+# - "*" The * (match all pattern) can be used to skip checksum file creating completely.
+#
+# PACK_CHECKSUM_EXCLUDE="
+#
+# "
-# custom preprocessing steps
+#
+# custom pre-processing steps
+#
+# usage: preprocess
+# The build folder
+#
function preprocess() {
- ./DoxyGen/gen_doc.sh
+ # add custom steps here to be executed
+ # before populating the pack build folder
+ pushd ./Documentation/Doxygen/ > /dev/null
+ echo "Changing working directory to $(pwd)"
+
+ echo "Executing ./gen_doc.sh"
+ ./gen_doc.sh
+
+ popd > /dev/null
+ echo "Changing working directory to $(pwd)"
+ return 0
}
+#
# custom post-processing steps
-# function postprocess() {
-# }
+#
+# usage: postprocess
+# The build folder
+#
+function postprocess() {
+ # add custom steps here to be executed
+ # after populating the pack build folder
+ # but before archiving the pack into output folder
+ return 0
+}
############ DO NOT EDIT BELOW ###########
-function install_lib() {
- local URL="https://github.com/Open-CMSIS-Pack/gen-pack/archive/refs/tags/v$1.tar.gz"
- echo "Downloading gen-pack lib to '$2'"
- mkdir -p "$2"
- curl -L "${URL}" -s | tar -xzf - --strip-components 1 -C "$2" || exit 1
-}
-
-function load_lib() {
- if [[ -d ${GEN_PACK_LIB} ]]; then
- . "${GEN_PACK_LIB}/gen-pack"
- return 0
- fi
- local GLOBAL_LIB="/usr/local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
- local USER_LIB="${HOME}/.local/share/gen-pack/${REQUIRED_GEN_PACK_LIB}"
- if [[ ! -d "${GLOBAL_LIB}" && ! -d "${USER_LIB}" ]]; then
- echo "Required gen_pack lib not found!" >&2
- install_lib "${REQUIRED_GEN_PACK_LIB}" "${USER_LIB}"
- fi
-
- if [[ -d "${GLOBAL_LIB}" ]]; then
- . "${GLOBAL_LIB}/gen-pack"
- elif [[ -d "${USER_LIB}" ]]; then
- . "${USER_LIB}/gen-pack"
- else
- echo "Required gen-pack lib is not installed!" >&2
- exit 1
- fi
-}
+# Set GEN_PACK_LIB_PATH to use a specific gen-pack library root
+# ... instead of bootstrap based on REQUIRED_GEN_PACK_LIB
+if [[ -n "${GEN_PACK_LIB_PATH}" ]] && [[ -f "${GEN_PACK_LIB_PATH}/gen-pack" ]]; then
+ . "${GEN_PACK_LIB_PATH}/gen-pack"
+else
+ . <(curl -sL "https://raw.githubusercontent.com/Open-CMSIS-Pack/gen-pack/main/bootstrap")
+fi
-load_lib
gen_pack "${DEFAULT_ARGS[@]}" "$@"
exit 0