aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/common/rsc/custom.css (renamed from doc/rt/rsc/custom.css)0
-rw-r--r--doc/common/rsc/footer_chm.html (renamed from doc/rt/rsc/footer_chm.html)0
-rw-r--r--doc/common/rsc/footer_html.html12
-rw-r--r--doc/common/rsc/header_chm.html (renamed from doc/rt/rsc/header_chm.html)2
-rw-r--r--doc/common/rsc/header_html.html (renamed from doc/rt/rsc/header_html.html)2
-rw-r--r--doc/common/rsc/layout.xml (renamed from doc/rt/rsc/layout.xml)0
-rw-r--r--doc/common/rsc/logo.png (renamed from doc/rt/rsc/logo.png)bin16818 -> 16818 bytes
-rw-r--r--doc/rt/Doxyfile_chm39
-rw-r--r--doc/rt/Doxyfile_html29
-rw-r--r--doc/rt/rsc/footer_html.html24
-rw-r--r--doc/rt/src/main.dox2
11 files changed, 43 insertions, 67 deletions
diff --git a/doc/rt/rsc/custom.css b/doc/common/rsc/custom.css
index 4ac73ab1a..4ac73ab1a 100644
--- a/doc/rt/rsc/custom.css
+++ b/doc/common/rsc/custom.css
diff --git a/doc/rt/rsc/footer_chm.html b/doc/common/rsc/footer_chm.html
index 6f8038e4f..6f8038e4f 100644
--- a/doc/rt/rsc/footer_chm.html
+++ b/doc/common/rsc/footer_chm.html
diff --git a/doc/common/rsc/footer_html.html b/doc/common/rsc/footer_html.html
new file mode 100644
index 000000000..0b176f750
--- /dev/null
+++ b/doc/common/rsc/footer_html.html
@@ -0,0 +1,12 @@
+ <li class="footer">
+ <a href="http://sourceforge.net/projects/chibios">
+ <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=205897&amp;type=11"
+ border="0" width="120" height="30"
+ alt="Get ChibiOS/RT embedded RTOS at SourceForge.net. Fast,
+ secure and Free Open Source software downloads"/>
+ </a>
+ </li>
+ </ul>
+</div>
+</body>
+</html>
diff --git a/doc/rt/rsc/header_chm.html b/doc/common/rsc/header_chm.html
index 66a8e3672..c83f9f7c6 100644
--- a/doc/rt/rsc/header_chm.html
+++ b/doc/common/rsc/header_chm.html
@@ -13,7 +13,7 @@
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
- <div id="projectname">ChibiOS/RT&#160;<span id="projectnumber">$projectnumber</span></div>
+ <div id="projectname">$projectname&#160;<span id="projectnumber">$projectnumber</span></div>
</td>
</tr>
</tbody>
diff --git a/doc/rt/rsc/header_html.html b/doc/common/rsc/header_html.html
index 631dec2b1..05eacc338 100644
--- a/doc/rt/rsc/header_html.html
+++ b/doc/common/rsc/header_html.html
@@ -20,7 +20,7 @@ $(document).ready(initResizable);
<tbody>
<tr style="height: 92px;">
<td style="padding-left: 0.5em;">
- <div id="projectname">ChibiOS/RT<br><span id="projectnumber">$projectnumber</span></div>
+ <div id="projectname">$projectname<br><span id="projectnumber">$projectnumber</span></div>
</td>
<td style="padding-left: 3em;">
<script type="text/javascript"><!--
diff --git a/doc/rt/rsc/layout.xml b/doc/common/rsc/layout.xml
index 9ec514ba8..9ec514ba8 100644
--- a/doc/rt/rsc/layout.xml
+++ b/doc/common/rsc/layout.xml
diff --git a/doc/rt/rsc/logo.png b/doc/common/rsc/logo.png
index 7948daefb..7948daefb 100644
--- a/doc/rt/rsc/logo.png
+++ b/doc/common/rsc/logo.png
Binary files differ
diff --git a/doc/rt/Doxyfile_chm b/doc/rt/Doxyfile_chm
index e0ae70da1..a33b69ff6 100644
--- a/doc/rt/Doxyfile_chm
+++ b/doc/rt/Doxyfile_chm
@@ -31,7 +31,7 @@ PROJECT_NAME = ChibiOS/RT
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = 2.6.7
+PROJECT_NUMBER = 3.0.0dev
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer
@@ -581,7 +581,7 @@ FILE_VERSION_FILTER =
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.
-LAYOUT_FILE = ./rsc/layout.xml
+LAYOUT_FILE = ../common/rsc/layout.xml
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
@@ -643,13 +643,12 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../docs/src \
- ../os/kernel \
- ../os/ports \
- ../os/hal \
- ../os/various \
- ../test \
- ../ext/ext.dox
+INPUT = ./src \
+ ../../os/rt/dox \
+ ../../os/rt/src \
+ ../../os/rt/include \
+ ../../os/rt/templates \
+ ../../test/rt
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -701,20 +700,13 @@ FILE_PATTERNS = *.c \
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
-RECURSIVE = YES
+RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = ../os/ports/common/ARMCMx/CMSIS \
- ../os/ports/GCC/SIMIA32 \
- ../os/hal/platforms \
- ../os/hal/templates/meta \
- ../os/various\devices_lib \
- ../os/various\fatfs_bindings \
- ../os/various\lwip_bindings \
- ../test/coverage
+EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -762,7 +754,8 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
-IMAGE_PATH = ./rsc
+IMAGE_PATH = ../common/rsc \
+ ./rsc
# 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
@@ -910,13 +903,13 @@ HTML_FILE_EXTENSION = .html
# that header. Note that the header is subject to change so you typically
# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
-HTML_HEADER = ./rsc/header_chm.html
+HTML_HEADER = ../common/rsc/header_chm.html
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
-HTML_FOOTER = ./rsc/footer_chm.html
+HTML_FOOTER = ../common/rsc/footer_chm.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
@@ -1030,7 +1023,7 @@ GENERATE_HTMLHELP = YES
# can add a path in front of the file if the result should not be
# written to the html output directory.
-CHM_FILE = ../ChibiOS_RT.chm
+CHM_FILE = ../../ChibiOS_RT.chm
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
@@ -1760,7 +1753,7 @@ DOT_GRAPH_MAX_NODES = 20
# code bases. Also note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
-MAX_DOT_GRAPH_DEPTH = 3
+MAX_DOT_GRAPH_DEPTH = 2
# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
# background. This is disabled by default, because dot on Windows does not
diff --git a/doc/rt/Doxyfile_html b/doc/rt/Doxyfile_html
index b0aca1340..f1f65de62 100644
--- a/doc/rt/Doxyfile_html
+++ b/doc/rt/Doxyfile_html
@@ -581,7 +581,7 @@ FILE_VERSION_FILTER =
# You can optionally specify a file name after the option, if omitted
# DoxygenLayout.xml will be used as the name of the layout file.
-LAYOUT_FILE = ./rsc/layout.xml
+LAYOUT_FILE = ../common/rsc/layout.xml
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
@@ -643,11 +643,12 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = ../doc/src \
- ../os/rt/dox \
- ../os/rt/src \
- ../os/rt/include \
- ../os/rt/templates \
+INPUT = ./src \
+ ../../os/rt/dox \
+ ../../os/rt/src \
+ ../../os/rt/include \
+ ../../os/rt/templates \
+ ../../test/rt
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -705,14 +706,7 @@ RECURSIVE = NO
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
-EXCLUDE = ../os/ports/common/ARMCMx/CMSIS \
- ../os/ports/GCC/SIMIA32 \
- ../os/hal/platforms \
- ../os/hal/templates/meta \
- ../os/various\devices_lib \
- ../os/various\fatfs_bindings \
- ../os/various\lwip_bindings \
- ../test/coverage
+EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -760,7 +754,8 @@ EXAMPLE_RECURSIVE = NO
# directories that contain image that are included in the documentation (see
# the \image command).
-IMAGE_PATH = ./rsc
+IMAGE_PATH = ../common/rsc \
+ ./rsc
# 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
@@ -908,13 +903,13 @@ HTML_FILE_EXTENSION = .html
# that header. Note that the header is subject to change so you typically
# have to redo this when upgrading to a newer version of doxygen or when changing the value of configuration settings such as GENERATE_TREEVIEW!
-HTML_HEADER = ./rsc/header_html.html
+HTML_HEADER = ../common/rsc/header_html.html
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
-HTML_FOOTER = ./rsc/footer_html.html
+HTML_FOOTER = ../common/rsc/footer_html.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
diff --git a/doc/rt/rsc/footer_html.html b/doc/rt/rsc/footer_html.html
deleted file mode 100644
index d6f2fa429..000000000
--- a/doc/rt/rsc/footer_html.html
+++ /dev/null
@@ -1,24 +0,0 @@
- <li class="footer">
- <a href="http://sourceforge.net/projects/chibios">
- <img src="http://sflogo.sourceforge.net/sflogo.php?group_id=205897&amp;type=11"
- border="0" width="120" height="30"
- alt="Get ChibiOS/RT embedded RTOS at SourceForge.net. Fast,
- secure and Free Open Source software downloads"/>
- </a>
- </li>
- </ul>
-</div>
-<!-- Piwik -->
-<script type="text/javascript">
-var pkBaseURL = (("https:" == document.location.protocol) ? "https://apps.sourceforge.net/piwik/chibios/" : "http://apps.sourceforge.net/piwik/chibios/");
-document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));
-</script><script type="text/javascript">
-piwik_action_name = '';
-piwik_idsite = 1;
-piwik_url = pkBaseURL + "piwik.php";
-piwik_log(piwik_action_name, piwik_idsite, piwik_url);
-</script>
-<object><noscript><p><img src="http://apps.sourceforge.net/piwik/chibios/piwik.php?idsite=1" alt="piwik"/></p></noscript></object>
-<!-- End Piwik Tag -->
-</body>
-</html>
diff --git a/doc/rt/src/main.dox b/doc/rt/src/main.dox
index fd1e8e780..937214615 100644
--- a/doc/rt/src/main.dox
+++ b/doc/rt/src/main.dox
@@ -26,7 +26,7 @@
*/
/**
- * @mainpage ChibiOS/RT
+ * @mainpage Introdution
* @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
*
* <h2>Chibi ?</h2>
generated by cgit v1.2.3 (git 2.25.1) at 2024-10-03 03:38:41 +0000