diff options
Diffstat (limited to 'docs')
| -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 |
14 files changed, 2 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 |
