[Toon-members] TooN/doc documentation.h

[Edward Rosten]

CVSROOT:        /cvsroot/toon
Module name:    TooN
Changes by:     Edward Rosten <edrosten>        09/09/23 12:46:28

Modified files:
        doc            : documentation.h 

Log message:
        Documentation fix from Ville Kyrki.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/TooN/doc/documentation.h?cvsroot=toon&r1=1.37&r2=1.38

Patches:
Index: documentation.h
===================================================================
RCS file: /cvsroot/toon/TooN/doc/documentation.h,v
retrieving revision 1.37
retrieving revision 1.38
diff -u -b -r1.37 -r1.38
--- documentation.h     27 Aug 2009 17:26:34 -0000      1.37
+++ documentation.h     23 Sep 2009 12:46:28 -0000      1.38
@@ -275,7 +275,7 @@
 
                Matrices can be filled from data in row-major order:
                @code
-                       Matrix<3> m = data(1, 2, 3, 4, 5, 6, 7, 8, 9);
+                       Matrix<3> m = Data(1, 2, 3, 4, 5, 6, 7, 8, 9);
                @endcode
 
                A less general, but visually more pleasing syntax can also be 
used:
@@ -335,6 +335,15 @@
        is checked at run-time in the dynamic case (with some additions). 
Checks can
        be disabled with various macros. Note that the optimizer will usually
        remove run-time checks on static objects if the test passes.
+       
+       Bounds are not checked by default. Bounds checking can be enabled by
+       defining the macro \c TOON_CHECK_BOUNDS. None of these macros change the
+       interface, so debugging code can be freely mixed with optimized code.
+
+       The debugging checks can be disabled by defining either of the 
following macros:
+       - \c TOON_NDEBUG
+       - \c NDEBUG 
+       Additionally, individual checks can be disabled with the following 
macros:
        - Static/Dynamic mismatch
                - Statically determined functions accept and ignore dynamically 
specified
                  sizes. Nevertheless, it is an error if they do not match.
@@ -348,10 +357,6 @@
        - underfilling using Fill (run-time check)
                - Disable with \c TOON_NDEBUG_FILL
        
-       Bounds are
-       not checked by default. Bounds checking can be enabled by defining the 
macro
-       \c TOON_CHECK_BOUNDS. None of these macros change the interface, so 
debugging
-       code can be freely mixed with optimized code.