diff -r bf228b5f648f -r 2640cf6547ff doc/graph_io.dox
--- a/doc/graph_io.dox Sat Apr 09 19:32:06 2005 +0000
+++ b/doc/graph_io.dox Sat Apr 09 19:35:33 2005 +0000
@@ -2,7 +2,6 @@
/*!
-
\page graph-io-page Graph Input-Output
The standard graph IO makes possible to store graphs and additional maps
@@ -20,8 +19,8 @@
The nodeset section starts with the \c \@nodeset line.
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
@nodeset
@@ -35,7 +34,7 @@
same coloumn oriented structure. It starts with the line \c \@edgeset
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
@edgeset
@@ -45,10 +44,10 @@
3 12 g 3.4 g-edge
\endcode
-The next section contains labeles nodes (i.e. nodes having a special
+The next section contains labeled nodes (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
@nodes
@@ -56,9 +55,8 @@
target 12
\endcode
-The last section describes the labeles edges
-(i.e. edges having a special
-label on them). It starts with \c \@edges
+The last section describes the labeled edges
+(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.
\code
@@ -88,13 +86,13 @@
Edge writing.
\code
-GraphWriter writer(graph);
+GraphWriter 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
@@ -108,8 +106,7 @@
\endcode
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
\code
@@ -132,7 +129,7 @@
\endcode
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
writer.run();
@@ -151,7 +148,7 @@
it should skip the values when the string representation contains spaces.
\code
-GraphReader reader(graph);
+GraphReader reader(std::cin, graph);
\endcode
The \c addNodeMap() function reads a map from the \c \@nodeset section.
@@ -206,7 +203,7 @@
If you want to change the functionality of the reader, you can use
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.
The reader has the next structure:
@@ -244,6 +241,6 @@
The specialization of the writing should be very similar to the reading.
-
+\author Balazs Dezso
*/
-}
\ No newline at end of file
+}