r41:b11737922197
Mon, 07 Jan 2008 19:23:03
[Not Reviewed]
0 comments (0 inline)
0
2
0
| ... | ... |
@@ -29,25 +29,25 @@ |
| 29 | 29 |
it. Please comply with these conventions if you want to contribute |
| 30 | 30 |
developing LEMON library. |
| 31 | 31 |
|
| 32 | 32 |
\note When the coding style requires the capitalization of an abbreviation, |
| 33 | 33 |
only the first letter should be upper case. |
| 34 | 34 |
|
| 35 | 35 |
\code |
| 36 | 36 |
XmlReader |
| 37 | 37 |
\endcode |
| 38 | 38 |
|
| 39 | 39 |
|
| 40 | 40 |
\warning In some cases we diverge from these rules. |
| 41 |
This primary done because STL uses different naming convention and |
|
| 41 |
This is primary done because STL uses different naming convention and |
|
| 42 | 42 |
in certain cases |
| 43 | 43 |
it is beneficial to provide STL compatible interface. |
| 44 | 44 |
|
| 45 | 45 |
\subsection cs-files File Names |
| 46 | 46 |
|
| 47 | 47 |
The header file names should look like the following. |
| 48 | 48 |
|
| 49 | 49 |
\code |
| 50 | 50 |
header_file.h |
| 51 | 51 |
\endcode |
| 52 | 52 |
|
| 53 | 53 |
Note that all standard LEMON headers are located in the \c lemon subdirectory, |
| ... | ... |
@@ -86,24 +86,32 @@ |
| 86 | 86 |
\code |
| 87 | 87 |
ALL_UPPER_CASE_WITH_UNDERSCORES |
| 88 | 88 |
\endcode |
| 89 | 89 |
|
| 90 | 90 |
\subsection cs-loc-var Class and instance member variables, auto variables |
| 91 | 91 |
|
| 92 | 92 |
The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following. |
| 93 | 93 |
|
| 94 | 94 |
\code |
| 95 | 95 |
all_lower_case_with_underscores |
| 96 | 96 |
\endcode |
| 97 | 97 |
|
| 98 |
\subsection pri-loc-var Private member variables |
|
| 99 |
|
|
| 100 |
Private member variables should start with underscore |
|
| 101 |
|
|
| 102 |
\code |
|
| 103 |
_start_with_underscores |
|
| 104 |
\endcode |
|
| 105 |
|
|
| 98 | 106 |
\subsection cs-excep Exceptions |
| 99 | 107 |
|
| 100 | 108 |
When writing exceptions please comply the following naming conventions. |
| 101 | 109 |
|
| 102 | 110 |
\code |
| 103 | 111 |
ClassNameEndsWithException |
| 104 | 112 |
\endcode |
| 105 | 113 |
|
| 106 | 114 |
or |
| 107 | 115 |
|
| 108 | 116 |
\code |
| 109 | 117 |
ClassNameEndsWithError |
| ... | ... |
@@ -559,26 +559,26 @@ |
| 559 | 559 |
This group contains some Experimental structures and algorithms. |
| 560 | 560 |
The stuff here is subject to change. |
| 561 | 561 |
*/ |
| 562 | 562 |
|
| 563 | 563 |
/** |
| 564 | 564 |
\anchor demoprograms |
| 565 | 565 |
|
| 566 | 566 |
@defgroup demos Demo programs |
| 567 | 567 |
|
| 568 | 568 |
Some demo programs are listed here. Their full source codes can be found in |
| 569 | 569 |
the \c demo subdirectory of the source tree. |
| 570 | 570 |
|
| 571 |
The standard compilation procedure (<tt>./configure;make</tt>) will compile |
|
| 572 |
them, as well. |
|
| 571 |
It order to compile them, use <tt>--enable-demo</tt> configure option when |
|
| 572 |
build the library. |
|
| 573 | 573 |
|
| 574 | 574 |
*/ |
| 575 | 575 |
|
| 576 | 576 |
/** |
| 577 | 577 |
@defgroup tools Standalone utility applications |
| 578 | 578 |
|
| 579 | 579 |
Some utility applications are listed here. |
| 580 | 580 |
|
| 581 | 581 |
The standard compilation procedure (<tt>./configure;make</tt>) will compile |
| 582 | 582 |
them, as well. |
| 583 | 583 |
|
| 584 | 584 |
*/ |
0 comments (0 inline)