Fix issues in documentation (#25)

- Dummy function in version.js to suppress JavaScript error - Add missing version dropdown image - Moved version selector css - Revert to Doxygen 1.9.2 due to layout issues in 1.9.5
ARM-software · Apr 5, 2023 · 66319df · 66319df
1 parent ea85c3c
commit 66319df
Show file tree

Hide file tree

Showing 8 changed files with 43 additions and 24 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -23,7 +23,7 @@ jobs:
 
       - uses: Open-CMSIS-Pack/gen-pack-action@main
         with:
-          doxygen-version: 1.9.5
+          doxygen-version: 1.9.2
           packchk-version: 1.3.96
           gen-doc-script: ./documentation/gen_doc.sh
           check-links-script: |

diff --git a/documentation/Doxygen_Templates/dropdown.png b/documentation/Doxygen_Templates/dropdown.png
diff --git a/documentation/Doxygen_Templates/extra_stylesheet.css b/documentation/Doxygen_Templates/extra_stylesheet.css
@@ -147,13 +147,13 @@ td.cmtab1 {
 
 table.cmtable {
 	border-collapse:collapse;
-        margin-top: 4px;
-        margin-bottom: 4px;
+	text-align: justify;
 }
 
 table.cmtable td, table.cmtable th {
 	border: 1px solid var(--arm_dark_gray);
 	padding: 3px 7px 2px;
+    vertical-align: text-top;
 }
 
 table.cmtable th {
@@ -277,7 +277,6 @@ p {
 	margin-block-start: 1em;
 	margin-block-end: 0.5em;
 }
-
 p.startli, p.startdd, p.starttd {
 	margin-top: 2px;
 }

diff --git a/documentation/Doxygen_Templates/header.html b/documentation/Doxygen_Templates/header.html
@@ -21,7 +21,7 @@
 $search
 $mathjax
 $extrastylesheet
-<link href="../version.css" rel="stylesheet" type="text/css" />
+<link href="$relpath^version.css" rel="stylesheet" type="text/css" />
 <script type="text/javascript" src="../version.js"></script>
 </head>
 <body>

diff --git a/documentation/version.css → documentation/Doxygen_Templates/version.css b/documentation/version.css → documentation/Doxygen_Templates/version.css
@@ -1,10 +1,27 @@
+: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;
+  --arm_yellow: #FFC700;
+}
+
 /* Dropdown Button */
 .dropbtn {
     margin: 0px;
-    padding: 0px 0px 0px 1ex;
-    background-image: url(dropdown.png);
+    padding: 0px 20px 0px 0em;
+    background-image: url("dropdown.png");
     background-repeat: no-repeat;
-    background-position: left center;
+    background-size: 0.5em;
+    background-position: right center;
+    cursor: pointer;
 }
 
 /* The container <div> - needed to position the dropdown content */
@@ -17,16 +34,18 @@
 .dropdown-content {
   display: none;
   position: absolute;
-  background-color: #f1f1f1;
+  background-color: var(--arm_light_gray3);
   min-width: 160px;
   box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.4);
+  white-space: nowrap;
+  cursor: pointer;
   z-index: 1;
 }
 
 /* Links inside the dropdown */
 .dropdown-content a {
   # color: black;
-  color: #3A568E;
+  color: var(--arm_dark_gray);
   padding: 4px 6px;
   text-decoration: none;
   display: block;

diff --git a/documentation/arm2d.dxy.in b/documentation/arm2d.dxy.in
@@ -772,7 +772,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            = ./Doxygen_Templates/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
@@ -834,7 +834,7 @@ WARN_IF_INCOMPLETE_DOC = YES
 # WARN_IF_INCOMPLETE_DOC
 # The default value is: NO.
 
-WARN_NO_PARAMDOC       = YES
+WARN_NO_PARAMDOC       = NO
 
 # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
 # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
@@ -871,7 +871,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                 = ../README.md \
+INPUT                  = ../README.md \
                          ./how_to_deploy_the_arm_2d_library.md \
                          ./introduction.md \
                          ./how_to_use_tile_operations.md \
@@ -888,10 +888,7 @@ INPUT                 = ../README.md \
                          ../Library/Include/arm_2d.h \
                          ../Helper/Include/arm_2d_helper_scene.h \
                          ../Helper/Include/arm_2d_helper_pfb.h \
-                         ../Helper/Include/arm_2d_helper.h \
-
-
-
+                         ../Helper/Include/arm_2d_helper.h
 
 # 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
@@ -1036,7 +1033,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =  ./pictures
+IMAGE_PATH             = ./pictures
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1331,6 +1328,8 @@ HTML_EXTRA_FILES       = ./Doxygen_Templates/tabs.css \
                          ./Doxygen_Templates/navtree.css \
                          ./Doxygen_Templates/tab_b.png \
                          ./Doxygen_Templates/navtree.js \
+                         ./Doxygen_Templates/version.css \
+                         ./Doxygen_Templates/dropdown.png
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to
@@ -1401,7 +1400,7 @@ HTML_DYNAMIC_SECTIONS  = NO
 # Minimum value: 0, maximum value: 9999, default value: 100.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_INDEX_NUM_ENTRIES = 1
+HTML_INDEX_NUM_ENTRIES = 100
 
 # If the GENERATE_DOCSET tag is set to YES, additional index files will be
 # generated that can be used as input for Apple's Xcode 3 integrated development
@@ -2306,8 +2305,10 @@ INCLUDE_FILE_PATTERNS  =
 PREDEFINED             = ARM_NONNULL(...)= \
                          __attribute__(...)= \
                          ARM_PRIVATE(...):=struct{__VA_ARGS__}; \
-                         implement_ex(__struct,__name):=__struct __name \
-                         inherit(x):=x use_as__##x;
+                         "implement_ex(__struct,__name):=__struct" \
+                         __name \
+                         inherit(x):=x \
+                         use_as__
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
 # tag can be used to specify a list of macro names that should be expanded. The

diff --git a/documentation/gen_doc.sh b/documentation/gen_doc.sh
@@ -13,7 +13,7 @@ set -o pipefail
 
 DIRNAME=$(dirname $(realpath $0))
 DOXYGEN=$(which doxygen)
-REQ_DXY_VERSION="1.9.5"
+REQ_DXY_VERSION="1.9.2"
 REQUIRED_GEN_PACK_LIB="0.7.0"
 
 ############ gen-pack library ###########

diff --git a/documentation/version.js b/documentation/version.js
@@ -1,3 +1,3 @@
-function myFunction() {
-  /* dummy function not used for local docs */ 
+function writeVersionDropdown() {
+  /* dummy function not used for local docs */
 }