diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-03 13:45:52 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-03 13:45:52 +0000 |
| commit | 7f61cb948ccdbd728643e0f174ee87542d9a862d (patch) | |
| tree | f2d13747ff831a123e9496ae3d215986a8056d49 | |
| parent | a6856d757a7960e9c50cb2cdce3e31ace9671541 (diff) | |
| download | ChibiOS-7f61cb948ccdbd728643e0f174ee87542d9a862d.tar.gz ChibiOS-7f61cb948ccdbd728643e0f174ee87542d9a862d.tar.bz2 ChibiOS-7f61cb948ccdbd728643e0f174ee87542d9a862d.zip | |
Added shortcut to the web documentation.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2233 35acf78f-673a-0410-8e92-d51de3d6d3f4
| -rw-r--r-- | docs/readme.txt | 22 | ||||
| -rw-r--r-- | docs/rsc/eclipse003.jpg | bin | 42621 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse004.jpg | bin | 49163 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse005.jpg | bin | 45472 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse006.jpg | bin | 15292 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse007.jpg | bin | 61644 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse008.jpg | bin | 19051 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse009.jpg | bin | 33845 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse010.jpg | bin | 29039 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse011.jpg | bin | 34286 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse012.jpg | bin | 12243 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/eclipse013.jpg | bin | 60847 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/tool001.jpg | bin | 22548 -> 0 bytes | |||
| -rw-r--r-- | docs/rsc/tool002.jpg | bin | 47193 -> 0 bytes | |||
| -rw-r--r-- | documentation.html | 8 | ||||
| -rw-r--r-- | readme.txt | 1 |
16 files changed, 11 insertions, 20 deletions
diff --git a/docs/readme.txt b/docs/readme.txt index 17d5b9136..e89c7161d 100644 --- a/docs/readme.txt +++ b/docs/readme.txt @@ -3,10 +3,10 @@ Open ./docs/index.html to open the start page or ./docs/html/index.html in
order to access directly the doxigen documentation.
-*** Documentation rebuild procedure ***
+*** Documentation build procedure ***
The following software must be installed:
-- Doxygen 1.5.7.1 or later.
+- Doxygen 1.6.3 or later.
- Graphviz 2.21 or later. The ./bin directory must be specified in the path in
order to make Graphviz accessible by Doxygen.
@@ -14,21 +14,3 @@ Build procedure: - Run Doxywizard.
- Load ./docs/Doxyfile from Doxywizard.
- Start.
-
-*** Doxygen usage rules ***
-- The JavaDoc style is recommended (@ instad of \, /** instead of /*!).
-- Params descriptions must not begin with a capital letter and must not be
- terminated with a dot unless it is composed of multiple paragraphs.
-- Retvals descriptions must not begin with a capital letter but must be
- terminated by a dot.
-- Normal paragraphs, return rescriptions and notes must start with a capital
- letter and must be terminated with a dot.
-- Multiple return values should be listed using the @retval command.
-- Parameters direction must be specified.
-
-Examples:
-@note This is a note.
-@retval RDY_OK is a possible return value.
-@return The pointer to the created thread is returned.
-@param[in] n the number of bytes to be written
-@param[in] n the number of bytes to be written. This value can be zero.
diff --git a/docs/rsc/eclipse003.jpg b/docs/rsc/eclipse003.jpg Binary files differdeleted file mode 100644 index a5cee7998..000000000 --- a/docs/rsc/eclipse003.jpg +++ /dev/null diff --git a/docs/rsc/eclipse004.jpg b/docs/rsc/eclipse004.jpg Binary files differdeleted file mode 100644 index 4d3fc2a85..000000000 --- a/docs/rsc/eclipse004.jpg +++ /dev/null diff --git a/docs/rsc/eclipse005.jpg b/docs/rsc/eclipse005.jpg Binary files differdeleted file mode 100644 index 63ce31e19..000000000 --- a/docs/rsc/eclipse005.jpg +++ /dev/null diff --git a/docs/rsc/eclipse006.jpg b/docs/rsc/eclipse006.jpg Binary files differdeleted file mode 100644 index fd56acdb5..000000000 --- a/docs/rsc/eclipse006.jpg +++ /dev/null diff --git a/docs/rsc/eclipse007.jpg b/docs/rsc/eclipse007.jpg Binary files differdeleted file mode 100644 index 9332d5777..000000000 --- a/docs/rsc/eclipse007.jpg +++ /dev/null diff --git a/docs/rsc/eclipse008.jpg b/docs/rsc/eclipse008.jpg Binary files differdeleted file mode 100644 index f602fa81e..000000000 --- a/docs/rsc/eclipse008.jpg +++ /dev/null diff --git a/docs/rsc/eclipse009.jpg b/docs/rsc/eclipse009.jpg Binary files differdeleted file mode 100644 index fb8264b11..000000000 --- a/docs/rsc/eclipse009.jpg +++ /dev/null diff --git a/docs/rsc/eclipse010.jpg b/docs/rsc/eclipse010.jpg Binary files differdeleted file mode 100644 index d92381ba2..000000000 --- a/docs/rsc/eclipse010.jpg +++ /dev/null diff --git a/docs/rsc/eclipse011.jpg b/docs/rsc/eclipse011.jpg Binary files differdeleted file mode 100644 index 1da305279..000000000 --- a/docs/rsc/eclipse011.jpg +++ /dev/null diff --git a/docs/rsc/eclipse012.jpg b/docs/rsc/eclipse012.jpg Binary files differdeleted file mode 100644 index e40725fa4..000000000 --- a/docs/rsc/eclipse012.jpg +++ /dev/null diff --git a/docs/rsc/eclipse013.jpg b/docs/rsc/eclipse013.jpg Binary files differdeleted file mode 100644 index bc8441eef..000000000 --- a/docs/rsc/eclipse013.jpg +++ /dev/null diff --git a/docs/rsc/tool001.jpg b/docs/rsc/tool001.jpg Binary files differdeleted file mode 100644 index f4a004fba..000000000 --- a/docs/rsc/tool001.jpg +++ /dev/null diff --git a/docs/rsc/tool002.jpg b/docs/rsc/tool002.jpg Binary files differdeleted file mode 100644 index c36767ea3..000000000 --- a/docs/rsc/tool002.jpg +++ /dev/null diff --git a/documentation.html b/documentation.html new file mode 100644 index 000000000..059a5a472 --- /dev/null +++ b/documentation.html @@ -0,0 +1,8 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+ <head>
+ <meta http-equiv="Refresh" content="0; URL=http://chibios.sourceforge.net/dokuwiki/doku.php?id=chibios:documents">
+ </head>
+ <body>
+ </body>
+</html>
diff --git a/readme.txt b/readme.txt index e9d42154e..e964706ed 100644 --- a/readme.txt +++ b/readme.txt @@ -4,6 +4,7 @@ --{root} - ChibiOS/RT directory.
+--readme.txt - This file.
+ +--documentation.html - Shortcut to the web documentation page.
+--todo.txt - Current plan (development/unstable versions only).
+--license.txt - GPL license text.
+--exception.txt - GPL exception text (stable releases only).
|
