Documentation-related fixes.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@11992 110e8d01-0319-4d1e-a829-52ad28d1bb01

4 files changed, 40 insertions, 38 deletions

diff --git a/doc/hal/Doxyfile_chm b/doc/hal/Doxyfile_chm
index 85e6e877e..0d36d6517 100644
--- a/doc/hal/Doxyfile_chm
+++ b/doc/hal/Doxyfile_chm
@@ -238,28 +238,28 @@ TAB_SIZE               = 2
 # "Side Effects:". You can put \n's in the value part of an alias to insert

 # newlines.

 

-ALIASES                = "iclass=@par Function Class:\n This is an \

+ALIASES                = "iclass=@par Function Class:<br>This is an \

                           <b>I-Class</b> API, this function can be \

                           invoked from within a system lock zone by both \

                           threads and interrupt handlers." \

-                         "sclass=@par Function Class:\n This is an \

+                         "sclass=@par Function Class:<br>This is an \

                           <b>S-Class</b> API, this function can be \

                           invoked from within a system lock zone by threads \

                           only." \

-                         "xclass=@par Function Class:\n This is an \

+                         "xclass=@par Function Class:<br>This is an \

                           <b>X-Class</b> API, this function can be \

                           invoked from any context." \

-                         "api=@par Function Class:\n Normal API, this \

+                         "api=@par Function Class:<br>Normal API, this \

                           function can be invoked by regular system threads \

                           but not from within a lock zone." \

-                         "notapi=@par Function Class:\n Not an API, this \

+                         "notapi=@par Function Class:<br>Not an API, this \

                           function is for internal use only." \

-                         "isr=@par Function Class:\n Interrupt handler, \

+                         "isr=@par Function Class:<br>Interrupt handler, \

                           this function should not be directly invoked." \

-                         "init=@par Function Class:\n Initializer, this \

+                         "init=@par Function Class:<br>Initializer, this \

                           function just initializes an object and can be \

                           invoked before the kernel is initialized." \

-                         "special=@par Function Class:\n Special function, \

+                         "special=@par Function Class:<br>Special function, \

                           this function has special requirements see the \

                           notes."

 

@@ -2369,7 +2369,7 @@ PLANTUML_JAR_PATH      =
 # Minimum value: 0, maximum value: 10000, default value: 50.

 # This tag requires that the tag HAVE_DOT is set to YES.

 

-DOT_GRAPH_MAX_NODES    = 20

+DOT_GRAPH_MAX_NODES    = 50

 

 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs

 # generated by dot. A depth value of 3 means that only nodes reachable from the

diff --git a/doc/hal/Doxyfile_html b/doc/hal/Doxyfile_html
index 26f296ba8..077cb58fb 100644
--- a/doc/hal/Doxyfile_html
+++ b/doc/hal/Doxyfile_html
@@ -238,28 +238,28 @@ TAB_SIZE               = 2
 # "Side Effects:". You can put \n's in the value part of an alias to insert

 # newlines.

 

-ALIASES                = "iclass=@par Function Class:\n This is an \

+ALIASES                = "iclass=@par Function Class:<br>This is an \

                           <b>I-Class</b> API, this function can be \

                           invoked from within a system lock zone by both \

                           threads and interrupt handlers." \

-                         "sclass=@par Function Class:\n This is an \

+                         "sclass=@par Function Class:<br>This is an \

                           <b>S-Class</b> API, this function can be \

                           invoked from within a system lock zone by threads \

                           only." \

-                         "xclass=@par Function Class:\n This is an \

+                         "xclass=@par Function Class:<br>This is an \

                           <b>X-Class</b> API, this function can be \

                           invoked from any context." \

-                         "api=@par Function Class:\n Normal API, this \

+                         "api=@par Function Class:<br>Normal API, this \

                           function can be invoked by regular system threads \

                           but not from within a lock zone." \

-                         "notapi=@par Function Class:\n Not an API, this \

+                         "notapi=@par Function Class:<br>Not an API, this \

                           function is for internal use only." \

-                         "isr=@par Function Class:\n Interrupt handler, \

+                         "isr=@par Function Class:<br>Interrupt handler, \

                           this function should not be directly invoked." \

-                         "init=@par Function Class:\n Initializer, this \

+                         "init=@par Function Class:<br>Initializer, this \

                           function just initializes an object and can be \

                           invoked before the kernel is initialized." \

-                         "special=@par Function Class:\n Special function, \

+                         "special=@par Function Class:<br>Special function, \

                           this function has special requirements see the \

                           notes."

 

@@ -2369,7 +2369,7 @@ PLANTUML_JAR_PATH      =
 # Minimum value: 0, maximum value: 10000, default value: 50.

 # This tag requires that the tag HAVE_DOT is set to YES.

 

-DOT_GRAPH_MAX_NODES    = 20

+DOT_GRAPH_MAX_NODES    = 50

 

 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs

 # generated by dot. A depth value of 3 means that only nodes reachable from the

diff --git a/doc/nil/Doxyfile_chm b/doc/nil/Doxyfile_chm
index 402797b26..4375bea26 100644
--- a/doc/nil/Doxyfile_chm
+++ b/doc/nil/Doxyfile_chm
@@ -238,28 +238,28 @@ TAB_SIZE               = 2
 # "Side Effects:". You can put \n's in the value part of an alias to insert

 # newlines.

 

-ALIASES                = "iclass=@par Function Class:\n This is an \

+ALIASES                = "iclass=@par Function Class:<br>This is an \

                           <b>I-Class</b> API, this function can be \

                           invoked from within a system lock zone by both \

                           threads and interrupt handlers." \

-                         "sclass=@par Function Class:\n This is an \

+                         "sclass=@par Function Class:<br>This is an \

                           <b>S-Class</b> API, this function can be \

                           invoked from within a system lock zone by threads \

                           only." \

-                         "xclass=@par Function Class:\n This is an \

+                         "xclass=@par Function Class:<br>This is an \

                           <b>X-Class</b> API, this function can be \

                           invoked from any context." \

-                         "api=@par Function Class:\n Normal API, this \

+                         "api=@par Function Class:<br>Normal API, this \

                           function can be invoked by regular system threads \

                           but not from within a lock zone." \

-                         "notapi=@par Function Class:\n Not an API, this \

+                         "notapi=@par Function Class:<br>Not an API, this \

                           function is for internal use only." \

-                         "isr=@par Function Class:\n Interrupt handler, \

+                         "isr=@par Function Class:<br>Interrupt handler, \

                           this function should not be directly invoked." \

-                         "init=@par Function Class:\n Initializer, this \

+                         "init=@par Function Class:<br>Initializer, this \

                           function just initializes an object and can be \

                           invoked before the kernel is initialized." \

-                         "special=@par Function Class:\n Special function, \

+                         "special=@par Function Class:<br>Special function, \

                           this function has special requirements see the \

                           notes."

 

@@ -791,8 +791,9 @@ INPUT                  = ./src \
                          ../../os/nil/src \

                          ../../os/nil/include \

                          ../../os/nil/templates \

-                         ../../os/common/oslib/src \

-                         ../../os/common/oslib/include

+                         ../../os/lib/dox \

+                         ../../os/lib/src \

+                         ../../os/lib/include

 

 # This tag can be used to specify the character encoding of the source files

 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

diff --git a/doc/nil/Doxyfile_html b/doc/nil/Doxyfile_html
index d35fd7ed8..4b7d0144a 100644
--- a/doc/nil/Doxyfile_html
+++ b/doc/nil/Doxyfile_html
@@ -238,28 +238,28 @@ TAB_SIZE               = 2
 # "Side Effects:". You can put \n's in the value part of an alias to insert

 # newlines.

 

-ALIASES                = "iclass=@par Function Class:\n This is an \

+ALIASES                = "iclass=@par Function Class:<br>This is an \

                           <b>I-Class</b> API, this function can be \

                           invoked from within a system lock zone by both \

                           threads and interrupt handlers." \

-                         "sclass=@par Function Class:\n This is an \

+                         "sclass=@par Function Class:<br>This is an \

                           <b>S-Class</b> API, this function can be \

                           invoked from within a system lock zone by threads \

                           only." \

-                         "xclass=@par Function Class:\n This is an \

+                         "xclass=@par Function Class:<br>This is an \

                           <b>X-Class</b> API, this function can be \

                           invoked from any context." \

-                         "api=@par Function Class:\n Normal API, this \

+                         "api=@par Function Class:<br>Normal API, this \

                           function can be invoked by regular system threads \

                           but not from within a lock zone." \

-                         "notapi=@par Function Class:\n Not an API, this \

+                         "notapi=@par Function Class:<br>Not an API, this \

                           function is for internal use only." \

-                         "isr=@par Function Class:\n Interrupt handler, \

+                         "isr=@par Function Class:<br>Interrupt handler, \

                           this function should not be directly invoked." \

-                         "init=@par Function Class:\n Initializer, this \

+                         "init=@par Function Class:<br>Initializer, this \

                           function just initializes an object and can be \

                           invoked before the kernel is initialized." \

-                         "special=@par Function Class:\n Special function, \

+                         "special=@par Function Class:<br>Special function, \

                           this function has special requirements see the \

                           notes."

 

@@ -791,8 +791,9 @@ INPUT                  = ./src \
                          ../../os/nil/src \

                          ../../os/nil/include \

                          ../../os/nil/templates \

-                         ../../os/common/oslib/src \

-                         ../../os/common/oslib/include

+                         ../../os/lib/dox \

+                         ../../os/lib/src \

+                         ../../os/lib/include

 

 # This tag can be used to specify the character encoding of the source files

 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses