Update documentation (#132)

- convert to Markdown format
- update style template

Author: VladimirUmek

ARM.CMSIS-FreeRTOS.pdsc

@@ -1295,7 +1295,7 @@
           #define RTE_RTOS_FreeRTOS_CONFIG_RTOS2  /* RTOS FreeRTOS Config for CMSIS RTOS2 API */
         </RTE_Components_h>
         <files>
-          <file category="doc"    name="Documentation/html/cre_freertos_proj.html#cmsis_freertos_config"/>
+          <file category="doc"    name="Documentation/html/page_create_project.html#configure_cmsis_freertos"/>
           <file category="header" attr="config" name="CMSIS/RTOS2/FreeRTOS/Config/FreeRTOSConfig.h" version="10.6.0"/>
         </files>
       </component>
@@ -1306,7 +1306,7 @@
           #define RTE_RTOS_FreeRTOS_CONFIG        /* RTOS FreeRTOS Config for FreeRTOS API */
         </RTE_Components_h>
         <files>
-          <file category="doc"    name="Documentation/html/cre_freertos_proj.html#native_freertos_config"/>
+          <file category="doc"    name="Documentation/html/page_create_project.html#configure_native_freertos"/>
           <file category="header" attr="config" name="Source/examples/template_configuration/FreeRTOSConfig.h" version="11.2.0"/>
         </files>
       </component>

Documentation/Doxygen/freertos.dxy.in

@@ -61,7 +61,7 @@ PROJECT_BRIEF          = "CMSIS-RTOS2 compliant FreeRTOS Implementation"
 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
 # the logo to the output directory.
 
-PROJECT_LOGO           = ./templates/cmsis_logo_white_small.png
+PROJECT_LOGO           = ./style_template/cmsis_logo_white_small.png
 
 # With the PROJECT_ICON tag one can specify an icon that is included in the tabs
 # when the HTML document is shown. Doxygen will copy the logo to the output
@@ -290,7 +290,12 @@ TAB_SIZE               = 2
 # with the commands \{ and \} for these it is advised to use the version @{ and
 # @} or use a double escape (\\{ and \\})
 
-ALIASES                = "token{1}=<span class=\"XML-Token\">\1</span>"
+ALIASES                = "token{1}=<span class=\"XML-Token\">\1</span>" \
+                         "div{1}=<hr><div class=\"\1\">" \
+                         "enddiv= </div>" \
+                         "func{1}=<kbd>\1</kbd> <br>" \
+                         "copybrief{1}=<br> \copybrief \1 <br>" \
+                         "none=\em none <br>"
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
@@ -368,7 +373,7 @@ MARKDOWN_SUPPORT       = YES
 # Minimum value: 0, maximum value: 99, default value: 6.
 # This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
 
-TOC_INCLUDE_HEADINGS   = 5
+TOC_INCLUDE_HEADINGS   = 3
 
 # The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
 # generate identifiers for the Markdown headings. Note: Every identifier is
@@ -839,7 +844,7 @@ FILE_VERSION_FILTER    =
 # DoxygenLayout.xml, Doxygen will parse it automatically even if the LAYOUT_FILE
 # tag is left empty.
 
-LAYOUT_FILE            = ./templates/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
@@ -991,10 +996,14 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ./src/cmsis_freertos.txt \
+INPUT                  = ./src/mainpage.md \
+                         ./src/history.txt \
+                         ./src/create_project.md \
+                         ./src/example_projects.md \
+                         ./src/technical_data.md \
+                         ./src/function_overview.md \
                          ./src/cmsis_rtos2_validation.txt \
                          ./src/freertos_evr.txt \
-                         ./src/history.txt \
                          ../../CMSIS/RTOS2/FreeRTOS/Include/freertos_evr.h
 
 # This tag can be used to specify the character encoding of the source files
@@ -1416,7 +1425,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            = ./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
@@ -1426,7 +1435,7 @@ HTML_HEADER            = ./templates/header.html
 # that Doxygen normally uses.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_FOOTER            = ./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
@@ -1456,8 +1465,11 @@ HTML_STYLESHEET        =
 # documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_STYLESHEET  = ./templates/extra_stylesheet.css \
-                         ./templates/extra_search.css
+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
@@ -1467,15 +1479,11 @@ HTML_EXTRA_STYLESHEET  = ./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       = ./templates/tabs.css \
-                         ./templates/search.css \
-                         ./templates/navtree.css \
-                         ./templates/tab_b.png \
-                         ./templates/navtree.js \
-                         ./templates/version.css \
-                         ./templates/dropdown.png \
-                         ../../LICENSE \
-                         ../../Source/LICENSE.md \
+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 \
                          ./src/cmsis_rtos2_validation.txt
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
@@ -1489,7 +1497,7 @@ HTML_EXTRA_FILES       = ./templates/tabs.css \
 # The default value is: AUTO_LIGHT.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_COLORSTYLE        = AUTO_LIGHT
+HTML_COLORSTYLE        = TOGGLE
 
 # 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

Documentation/Doxygen/gen_doc.sh

@@ -72,9 +72,9 @@ fi
 
 pushd "${DIRNAME}" > /dev/null
 
-echo "Generating documentation ..."
+echo_log "Generating documentation ..."
 
-projectName=$(grep -E "PROJECT_NAME\s+=" freertos.dxy.in | sed -r -e 's/[^"]*"([^"]+)".*/\1/')
+projectName=$(grep -E "PROJECT_NAME\s+=" freertos.dxy.in | sed -r -e 's/^PROJECT_NAME\s*=\s*"?([^"]*)"?/\1/')
 projectNumberFull="${VERSION_FULL}"
 projectNumber="${projectNumberFull%+*}"
 datetime=$(date -u +'%a %b %e %Y %H:%M:%S')
@@ -84,23 +84,24 @@ sed -e "s/{projectNumber}/${projectNumber}/" freertos.dxy.in > freertos.dxy
 
 git_changelog -f html -p "v" > src/history.txt
 
-echo "\"${UTILITY_DOXYGEN}\" freertos.dxy"
+echo_log "\"${UTILITY_DOXYGEN}\" freertos.dxy"
 "${UTILITY_DOXYGEN}" freertos.dxy
 
 mkdir -p "${DIRNAME}/${GENDIR}/search/"
-cp -f "${DIRNAME}/templates/search.css" "${DIRNAME}/${GENDIR}/search/"
-cp -f "${DIRNAME}/templates/navtree.js" "${DIRNAME}/${GENDIR}/"
+cp -f "${DIRNAME}/style_template/search.css" "${DIRNAME}/${GENDIR}/search/"
+cp -f "${DIRNAME}/style_template/search.js" "${DIRNAME}/${GENDIR}/search/"
+cp -f "${DIRNAME}/style_template/navtree.js" "${DIRNAME}/${GENDIR}"
+cp -f "${DIRNAME}/style_template/resize.js" "${DIRNAME}/${GENDIR}"
 
-sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/templates/footer.js.in" \
+sed -e "s/{datetime}/${datetime}/" "${DIRNAME}/style_template/footer.js.in" \
   | sed -e "s/{year}/${year}/" \
   | sed -e "s/{projectName}/${projectName}/" \
   | sed -e "s/{projectNumber}/${projectNumber}/" \
   | sed -e "s/{projectNumberFull}/${projectNumberFull}/" \
   > "${DIRNAME}/${GENDIR}/footer.js"
 
-popd  > /dev/null
-
-[[ ${RUN_LINKCHECKER} != 0 ]] && check_links "${DIRNAME}/../html/index.html" "${DIRNAME}"
+popd > /dev/null || exit 1
 
+[[ ${RUN_LINKCHECKER} != 0 ]] && check_links "${DIRNAME}/${GENDIR}/index.html" "${DIRNAME}"
 
 exit 0

Documentation/Doxygen/linkchecker.rc

@@ -6,6 +6,10 @@ ignoreerrors=
     mag_seld.svg
     ../tab_a.png
     ../tab_ad.png
+    minus.svg
+    plus.svg
+    minusd.svg
+    plusd.svg
 
 [filtering]
 ignorewarnings=