Changeset 1333:2640cf6547ff in lemon-0.x for doc/graph_io.dox

Timestamp:

04/09/05 21:35:33 (19 years ago)

Author:

Balazs Dezso

Branch:

default

Phase:

public

Convert:

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

Message:

Functionality changed:
The first map is the id map => The map named "id" is the id map

Documentation improvments

File:

• doc/graph_io.dox (modified) (11 diffs)

doc/graph_io.dox

@@ -1 +1 @@
 namespace lemon {
 /*!
-
 
 
@@ -21 +20 @@
 The next line contains the names of the maps separated by whitespaces.
 Each following line describes a node in the graph, it contains
-in the right order the values of the maps. The first map should contain
-unique values because it regarded as Id-map. 
+in the right order the values of the maps. The map named "id" should contain
+unique values because it regarded as ID-map. 
 
 \code
@@ -36 +35 @@
 The next line contains the whitespace separated list of names of the map.
 Each of the next lines describes one edge. The first two elements in the line
-are the ID of the source and target node as they occur in the first node map. 
+are the ID of the source and target node as they occur in the ID node map. 
 
 \code
@@ -46 +45 @@
 \endcode
 
-The next section contains <em>labeles nodes</em> (i.e. nodes having a special
+The next section contains <em>labeled nodes</em> (i.e. nodes having a special
 label on them). The section starts with
 \c \@nodes. Each of the next lines contains a label for a node in the graph 
-and then the ID described in the first column in the nodeset.
+and then the ID described in the nodeset.
 
 \code
@@ -57 +56 @@
 \endcode
 
-The last section describes the <em>labeles edges</em>
-(i.e. edges having a special
-label on them). It starts with \c \@edges
+The last section describes the <em>labeled edges</em>
+(i.e. edges having a special label on them). It starts with \c \@edges
 and then each line contains the name of the edge and the ID.
 
@@ -89 +87 @@
 
 \code
-GraphWriter<ListGraph> writer(graph);
+GraphWriter<ListGraph> writer(std::cout, graph);
 \endcode
 
 The \c addNodeMap() function declares a \c NodeMap writing command in the
 \c GraphWriter. You should give as parameter the name of the map and the map
-object. The first NodeMap writing command should write a unique map because
-it is regarded as ID map.
+object. The NodeMap writing command with name "id" should write a 
+unique map because it is regarded as ID map.
 
 \see IdMap, DescriptorMap  
@@ -109 +107 @@
 
 With the \c addEdgeMap() member function you can give an edge map
-writing command similar to the NodeMaps. The first map writing command should
-write unique map.
+writing command similar to the NodeMaps.
 
 \see IdMap, DescriptorMap  
@@ -133 +130 @@
 
 After you give all write commands you must call the \c run() member
-function, which execute all the write commands.
+function, which execute all the writer commands.
 
 \code
@@ -152 +149 @@
 
 \code
-GraphReader<ListGraph> reader(graph);
+GraphReader<ListGraph> reader(std::cin, graph);
 \endcode
 
@@ -207 +204 @@
 template parameters to specialize it. When you give a reading
 command for a map you can give a Reader type as template parameter.
-With this template parameter you can control how does read the Reader
+With this template parameter you can control how the Reader reads
 a value from the stream.
 
@@ -245 +242 @@
 The specialization of the writing should be very similar to the reading.
 
-
+\author Balazs Dezso
 */
 }