Skip to content

Commit 4ba07c6

Browse files
author
gdisirio
committed
git-svn-id: https://chibios.svn.sourceforge.net/svnroot/chibios/trunk@2840 35acf78f-673a-0410-8e92-d51de3d6d3f4
1 parent dc2f5f1 commit 4ba07c6

9 files changed

+1819
-11
lines changed

docs/Doxyfile docs/Doxyfile_chm

+3-3
Original file line numberDiff line numberDiff line change
@@ -926,13 +926,13 @@ HTML_FILE_EXTENSION = .html
926926
# each generated HTML page. If it is left blank doxygen will generate a
927927
# standard header.
928928

929-
HTML_HEADER = ./rsc/header.html
929+
HTML_HEADER = ./rsc/header_chm.html
930930

931931
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
932932
# each generated HTML page. If it is left blank doxygen will generate a
933933
# standard footer.
934934

935-
HTML_FOOTER = ./rsc/footer.html
935+
HTML_FOOTER = ./rsc/footer_chm.html
936936

937937
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
938938
# style sheet that is used by each HTML page. It can be used to
@@ -1159,7 +1159,7 @@ ENUM_VALUES_PER_LINE = 4
11591159
# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
11601160
# Windows users are probably better off using the HTML help feature.
11611161

1162-
GENERATE_TREEVIEW = YES
1162+
GENERATE_TREEVIEW = NO
11631163

11641164
# By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
11651165
# and Class Hierarchy pages using a tree view instead of an ordered list.

docs/Doxyfile_html

+1,787
Large diffs are not rendered by default.

docs/readme.txt

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
1-
*** Documentation access ***
2-
3-
Open ./docs/index.html to open the start page or ./docs/html/index.html in
4-
order to access directly the doxigen documentation.
5-
61
*** Documentation build procedure ***
72

83
The following software must be installed:
@@ -12,5 +7,5 @@ The following software must be installed:
127

138
Build procedure:
149
- Run Doxywizard.
15-
- Load ./docs/Doxyfile from Doxywizard.
10+
- Load ./docs/Doxyfile_html or ./docs/Doxyfile_chm from Doxywizard.
1611
- Start.

docs/rsc/footer_chm.html

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<hr class="footer"/><address class="footer"><small>
2+
Generated on $datetime for $projectname by&#160;<a href="http://www.doxygen.org/index.html"><img class="footer" src="$relpath$doxygen.png" alt="doxygen"/></a> $doxygenversion</small></address>
3+
</body>
4+
</html>
File renamed without changes.

docs/rsc/header_chm.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<title>$title</title>
6+
<link href="$relpath$tabs.css" rel="stylesheet" type="text/css"/>
7+
<link href="$relpath$doxygen.css" rel="stylesheet" type="text/css"/>
8+
</head>
9+
<body>
10+
<div id="top"><!-- do not remove this div! -->
11+
<div id="titlearea">
12+
<table cellspacing="0" cellpadding="0">
13+
<tbody>
14+
<tr style="height: 56px;">
15+
<td style="padding-left: 0.5em;">
16+
<div id="projectname">ChibiOS/RT&#160;<span id="projectnumber">2.3.1</span></div>
17+
</td>
18+
</tr>
19+
</tbody>
20+
</table>
21+
</div>
File renamed without changes.

documentation.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
22
<html>
33
<head>
4-
<meta http-equiv="Refresh" content="0; URL=http://chibios.sourceforge.net/dokuwiki/doku.php?id=chibios:documents">
4+
<meta http-equiv="Refresh" content="0; URL=http://www.chibios.org/dokuwiki/doku.php?id=chibios:documents">
55
</head>
66
<body>
77
</body>

readme.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,8 @@
9797
more readable output. Also modified the documentation layout to put functions
9898
and variables ahead of everything else in the group pages.
9999
Doxygen version below 1.7.3 cannot be used anymore because differences in
100-
templates.
100+
templates. Note that now there are two Doxygen projects, one for generating
101+
the CHM file the other for plain HTML.
101102

102103
*** 2.3.0 ***
103104
- FIX: Fixed race condition in CM0 ports, the fix also improves the

0 commit comments

Comments
 (0)