From 3da942d2f91277a3f5af9ad56b231a07e7268042 Mon Sep 17 00:00:00 2001 From: jpr Date: Tue, 6 Sep 2005 15:38:38 +0000 Subject: [PATCH] Update Web pages --- Doc/Website/CodingStyle.html | 15 ++++++++++++--- Doc/Website/Cvs.html | 2 +- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/Doc/Website/CodingStyle.html b/Doc/Website/CodingStyle.html index 8deca8f1..1b0eb06f 100644 --- a/Doc/Website/CodingStyle.html +++ b/Doc/Website/CodingStyle.html @@ -71,7 +71,11 @@ Local variables begin in lowercase. There is more flexibility in the naming of local variables although they still should convey some semantics. - + - Naming function parameters: + Function parameters begin in lowercase. There is more flexibility in the + naming of function parameters although they still should convey some + semantics. + * Classes: - Don't use the inline keyword when defining an inline function within a class definition. @@ -84,6 +88,11 @@ { GroupPixel = groupPixel; } + - Don't use trailing ';' in inline function definition. + use : + void A::SetGroupPixel( int groupPixel ){GroupPixel = groupPixel;} + NOT + void A::SetGroupPixel( int groupPixel ){GroupPixel = groupPixel;}; - Do not repeat the virtual keyword when overriding virtual base methods in declaration of subclasses: class A @@ -189,7 +198,7 @@ The Doxygen open-source system is used to generate on-line documentation. Doxygen requires the embedding of simple comments in the code which is in turn extracted and formatted into documentation. See - http://www.stack.nl/ dimitri/doxygen/ + http://www.stack.nl/~dimitri/doxygen/ for more information about Doxygen. - Documenting a class: Classes should be documented using the class and brief doxygen commands, @@ -212,7 +221,7 @@ bool Readable = false; /// \brief The number of lines of the image as interpreted from - /// the various elements encountered at header parsing. + /// the various elements encountered at header parsing. int NumberOfLines = -1; /// Predicate implemented as accessor around \ref Readable. diff --git a/Doc/Website/Cvs.html b/Doc/Website/Cvs.html index b97926a7..42c9fef9 100644 --- a/Doc/Website/Cvs.html +++ b/Doc/Website/Cvs.html @@ -13,7 +13,7 @@ To learn more about CVS and to get the CVS programs, please refer to the -CVS Home. +CVS Home.