# HG changeset patch # User diego # Date 1171496641 0 # Node ID e438a5af7771472d4c4c4cc9f161a43e1fab20f4 # Parent 50d45af133a0a3cc85f864c0969a33c984e49bb8 random small fixes diff -r 50d45af133a0 -r e438a5af7771 DOCS/tech/code-documentation.txt --- a/DOCS/tech/code-documentation.txt Wed Feb 14 19:17:39 2007 +0000 +++ b/DOCS/tech/code-documentation.txt Wed Feb 14 23:44:01 2007 +0000 @@ -37,11 +37,11 @@ * its valid range * where it is set (optional) * where validity checking is done (optional, mandatory for variables which - are set by something external, eg user parameters, file information etc) + are set by something external, e.g. user parameters, file information etc) - #define, typedefs, structs * all global definitions - * all local definitions whose use is not imediatly clear by their name + * all local definitions whose use is not immediately clear by their name (as a rule of thumb, it's better to document too much than not enough) * all dependencies @@ -124,7 +124,7 @@ \warning Add a section for a warning. \anchor - Set an invisible anchor which can be used to create a link with /ref. + Set an invisible anchor which can be used to create a link with \ref. \ref [] Add a link to .