Changeset 955:0a066f80e05f in lemon-0.x for doc

Timestamp:

11/02/04 07:28:38 (20 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@1335

Message:

Improve docs.

Location:

doc

Files:

• coding_style.dox (modified) (6 diffs)
• named-param.dox (modified) (2 diffs)

doc/coding_style.dox

@@ -12 +12 @@
 developing LEMON library.
 
+\warning In some cases we diverge from these rules.
+This primary done because STL uses different naming convention and
+in certain cases
+it is beneficial to provide STL compatible interface.
+
+\subsection cs-files File Names
+
+The header file names should look like the following.
+
+\code
+header_file.h
+\endcode
+
+Note that all standard Lemon headers are located in the \c lemon subdirectory,
+so you should include them from C++ source like this:
+
+\code
+#include <lemon/header_file.h>
+\endcode
+
+The source code files use the same style and they have '.cc' extension.
+
+\code
+source_code.cc
+\endcode
+
 \subsection cs-class Classes and other types
 
-The name of a class or any type should look like the following:
+The name of a class or any type should look like the following.
 
 \code
@@ -22 +48 @@
 \subsection cs-func Methods and other functions
 
-The name of a function should look like the following:
+The name of a function should look like the following.
 
 \code
@@ -30 +56 @@
 \subsection cs-funcs Constants, Macros
 
-The names of constants and macros should look like the following:
+The names of constants and macros should look like the following.
 
 \code
@@ -38 +64 @@
 \subsection cs-loc-var Class and instance member variables, auto variables 
 
-The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following:
+The names of class and instance member variables and auto variables (=variables used locally in methods) should look like the following.
 
 \code
@@ -46 +72 @@
 \subsection cs-excep Exceptions
 
-When writing exceptions please comply the following naming conventions:
+When writing exceptions please comply the following naming conventions.
 
 \code
@@ -52 +78 @@
 \endcode
 
-\warning In some cases we diverge from these rules.
-This primary done because STL uses different naming convention and
-in certain cases
-it is beneficial to provide STL compatible interface.
-
 */

doc/named-param.dox

@@ -3 +3 @@
 \page named-param Named Parameters
 
-\section named-templ-param Named Template Parameters
+\section named-func-param Named "Function" Parameters
+
+
+\section traits-classes Traits Classes
+
+\section named-templ-param Named Class Template Parameters
 
 Instead of creating a new traits class you can also use this adaptor class
@@ -16 +21 @@
 \endcode
 
+\section named-templ-func-param Named "Function" Template Parameters
+
 
 */