[Lemon-commits] [lemon_svn] alpar: r1335 - in hugo/trunk: doc src/work/alpar

[Lemon SVN]

Author: alpar
Date: Tue Nov  2 07:28:38 2004
New Revision: 1335

Modified:
   hugo/trunk/doc/coding_style.dox
   hugo/trunk/doc/named-param.dox
   hugo/trunk/src/work/alpar/dijkstra.h

Log:
Improve docs.

Modified: hugo/trunk/doc/coding_style.dox
==============================================================================
--- hugo/trunk/doc/coding_style.dox	(original)
+++ hugo/trunk/doc/coding_style.dox	Tue Nov  2 07:28:38 2004
@@ -11,9 +11,35 @@
 it. Please comply with these conventions if you want to contribute
 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
 AllWordsCapitalizedWithoutUnderscores 
@@ -21,7 +47,7 @@
 
 \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
 firstWordLowerCaseRestCapitalizedWithoutUnderscores 
@@ -29,7 +55,7 @@
 
 \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
 ALL_UPPER_CASE_WITH_UNDERSCORES 
@@ -37,7 +63,7 @@
 
 \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
 all_lower_case_with_underscores 
@@ -45,15 +71,10 @@
 
 \subsection cs-excep Exceptions
 
-When writing exceptions please comply the following naming conventions:
+When writing exceptions please comply the following naming conventions.
 
 \code
 ClassNameEndsWithException
 \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.
-
 */

Modified: hugo/trunk/doc/named-param.dox
==============================================================================
--- hugo/trunk/doc/named-param.dox	(original)
+++ hugo/trunk/doc/named-param.dox	Tue Nov  2 07:28:38 2004
@@ -2,7 +2,12 @@
 
 \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
 like this
@@ -15,5 +20,7 @@
 Dijkstra<>::SetDistMap<MyMap>::SetPredMap<NullMap<Node,Edge> >
 \endcode
 
+\section named-templ-func-param Named "Function" Template Parameters
+
 
 */

Modified: hugo/trunk/src/work/alpar/dijkstra.h
==============================================================================
--- hugo/trunk/src/work/alpar/dijkstra.h	(original)
+++ hugo/trunk/src/work/alpar/dijkstra.h	Tue Nov  2 07:28:38 2004
@@ -109,7 +109,7 @@
   ///It is also possible to change the underlying priority heap.
   ///
   ///\param GR The graph type the algorithm runs on. The default value is
-  ///\ref ListGraph. The value of GR is not used directly by %Dijsktra, it
+  ///\ref ListGraph. The value of GR is not used directly by Dijkstra, it
   ///is only passed to \ref DijkstraDefaultTraits.
   ///\param LM This read-only
   ///EdgeMap
@@ -118,11 +118,11 @@
   ///may involve in relatively time consuming process to compute the edge
   ///length if it is necessary. The default map type is
   ///\ref skeleton::StaticGraph::EdgeMap "Graph::EdgeMap<int>".
-  ///The value of LM is not used directly by %Dijsktra, it
+  ///The value of LM is not used directly by Dijkstra, it
   ///is only passed to \ref DijkstraDefaultTraits.
   ///\param TR Traits class to set various data types used by the algorithm.
   ///The default traits class is
-  ///\ref DijkstraDefaultTraits<GR,LM> "DijkstraDefaultTraits<GR,LM>".
+  ///\ref DijkstraDefaultTraits "DijkstraDefaultTraits<GR,LM>".
   ///See \ref DijkstraDefaultTraits for the documentation of
   ///a Dijkstra traits class.
   ///