lemon-1.3: comparison lemon/lgf

equal deleted inserted replaced

-:524021b720a1
+:3669c8d9bd87
 *
 */
 ///\ingroup lemon_io
 ///\file
-///\brief Lemon Graph Format writer.
+///\brief \ref lgf-format "Lemon Graph Format" writer.
 #ifndef LEMON_LGF_WRITER_H
 #define LEMON_LGF_WRITER_H
 DigraphWriter<Digraph> digraphWriter(const char *fn,
 				       const Digraph& digraph);
 /// \ingroup lemon_io
 ///
-/// \brief LGF writer for directed graphs
+/// \brief \ref lgf-format "LGF" writer for directed graphs
 ///
 /// This utility writes an \ref lgf-format "LGF" file.
 ///
 /// The writing method does a batch processing. The user creates a
 /// writer object, then various writing rules can be added to the
 /// writer, and eventually the writing is executed with the \c run()
 /// member function. A map writing rule can be added to the writer
 /// with the \c nodeMap() or \c arcMap() members. An optional
 /// converter parameter can also be added as a standard functor
-/// converting from the value type of the map to std::string. If it
+/// converting from the value type of the map to \c std::string. If it
-/// is set, it will determine how the map's value type is written to
+/// is set, it will determine how the value type of the map is written to
 /// the output stream. If the functor is not set, then a default
 /// conversion will be used. The \c attribute(), \c node() and \c
 /// arc() functions are used to add attribute writing rules.
 ///
 ///\code
-///     DigraphWriter<Digraph>(std::cout, digraph).
+/// DigraphWriter<Digraph>(std::cout, digraph).
-///       nodeMap("coordinates", coord_map).
+///   nodeMap("coordinates", coord_map).
-///       nodeMap("size", size).
+///   nodeMap("size", size).
-///       nodeMap("title", title).
+///   nodeMap("title", title).
-///       arcMap("capacity", cap_map).
+///   arcMap("capacity", cap_map).
-///       node("source", src).
+///   node("source", src).
-///       node("target", trg).
+///   node("target", trg).
-///       attribute("caption", caption).
+///   attribute("caption", caption).
-///       run();
+///   run();
 ///\endcode
 ///
 ///
 /// By default, the writer does not write additional captions to the
 /// sections, but they can be give as an optional parameter of
 public:
 /// \name Writing rules
 /// @{
-/// \brief Node map reading rule
+/// \brief Node map writing rule
 ///
-/// Add a node map reading rule to the writer.
+/// Add a node map writing rule to the writer.
 template <typename Map>
 DigraphWriter& nodeMap(const std::string& caption, const Map& map) {
 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 _writer_bits::MapStorageBase<Node>* storage =
 	new _writer_bits::MapStorage<Node, Map>(map);
 	new _writer_bits::ValueStorage<Arc, Converter>(arc, converter);
 _attributes.push_back(std::make_pair(caption, storage));
 return *this;
 }
-/// \name Select section by name
+/// \name Section captions
 /// @{
-/// \brief Set \c \@nodes section to be read
+/// \brief Add an additional caption to the \c \@nodes section
 ///
-/// Set \c \@nodes section to be read
+/// Add an additional caption to the \c \@nodes section.
 DigraphWriter& nodes(const std::string& caption) {
 _nodes_caption = caption;
 return *this;
 }
-/// \brief Set \c \@arcs section to be read
+/// \brief Add an additional caption to the \c \@arcs section
 ///
-/// Set \c \@arcs section to be read
+/// Add an additional caption to the \c \@arcs section.
 DigraphWriter& arcs(const std::string& caption) {
 _arcs_caption = caption;
 return *this;
 }
-/// \brief Set \c \@attributes section to be read
+/// \brief Add an additional caption to the \c \@attributes section
 ///
-/// Set \c \@attributes section to be read
+/// Add an additional caption to the \c \@attributes section.
 DigraphWriter& attributes(const std::string& caption) {
 _attributes_caption = caption;
 return *this;
 }
 /// \name Skipping section
 /// @{
 /// \brief Skip writing the node set
 ///
-/// The \c \@nodes section will be not written to the stream.
+/// The \c \@nodes section will not be written to the stream.
 DigraphWriter& skipNodes() {
 LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member");
 _skip_nodes = true;
 return *this;
 }
 /// \brief Skip writing arc set
 ///
-/// The \c \@arcs section will be not written to the stream.
+/// The \c \@arcs section will not be written to the stream.
 DigraphWriter& skipArcs() {
 LEMON_ASSERT(!_skip_arcs, "Multiple usage of skipArcs() member");
 _skip_arcs = true;
 return *this;
 }
 /// \name Execution of the writer
 /// @{
 /// \brief Start the batch processing
 ///
-/// This function starts the batch processing
+/// This function starts the batch processing.
 void run() {
 if (!_skip_nodes) {
 	writeNodes();
 } else {
 	createNodeIndex();
 	createArcIndex();
 }
 writeAttributes();
 }
-/// \brief Gives back the stream of the writer
+/// \brief Give back the stream of the writer
 ///
-/// Gives back the stream of the writer
+/// Give back the stream of the writer.
 std::ostream& ostream() {
 return *_os;
 }
 /// @}
 };
+/// \brief Return a \ref DigraphWriter class
+///
+/// This function just returns a \ref DigraphWriter class.
 /// \relates DigraphWriter
 template <typename Digraph>
 DigraphWriter<Digraph> digraphWriter(std::ostream& os,
 				       const Digraph& digraph) {
 DigraphWriter<Digraph> tmp(os, digraph);
 return tmp;
 }
+/// \brief Return a \ref DigraphWriter class
+///
+/// This function just returns a \ref DigraphWriter class.
 /// \relates DigraphWriter
 template <typename Digraph>
 DigraphWriter<Digraph> digraphWriter(const std::string& fn,
 				       const Digraph& digraph) {
 DigraphWriter<Digraph> tmp(fn, digraph);
 return tmp;
 }
+/// \brief Return a \ref DigraphWriter class
+///
+/// This function just returns a \ref DigraphWriter class.
 /// \relates DigraphWriter
 template <typename Digraph>
 DigraphWriter<Digraph> digraphWriter(const char* fn,
 				       const Digraph& digraph) {
 DigraphWriter<Digraph> tmp(fn, digraph);
 template <typename Graph>
 GraphWriter<Graph> graphWriter(const char *fn, const Graph& graph);
 /// \ingroup lemon_io
 ///
-/// \brief LGF writer for directed graphs
+/// \brief \ref lgf-format "LGF" writer for directed graphs
 ///
 /// This utility writes an \ref lgf-format "LGF" file.
+///
+/// It can be used almost the same way as \c DigraphWriter.
+/// The only difference is that this class can handle edges and
+/// edge maps as well as arcs and arc maps.
 template <typename _Graph>
 class GraphWriter {
 public:
 typedef _Graph Graph;
 public:
 /// \name Writing rules
 /// @{
-/// \brief Node map reading rule
+/// \brief Node map writing rule
 ///
-/// Add a node map reading rule to the writer.
+/// Add a node map writing rule to the writer.
 template <typename Map>
 GraphWriter& nodeMap(const std::string& caption, const Map& map) {
 checkConcept<concepts::ReadMap<Node, typename Map::Value>, Map>();
 _writer_bits::MapStorageBase<Node>* storage =
 	new _writer_bits::MapStorage<Node, Map>(map);
 	new _writer_bits::ValueStorage<Arc, Converter>(arc, converter);
 _attributes.push_back(std::make_pair(caption, storage));
 return *this;
 }
-/// \name Select section by name
+/// \name Section captions
 /// @{
-/// \brief Set \c \@nodes section to be read
+/// \brief Add an additional caption to the \c \@nodes section
 ///
-/// Set \c \@nodes section to be read
+/// Add an additional caption to the \c \@nodes section.
 GraphWriter& nodes(const std::string& caption) {
 _nodes_caption = caption;
 return *this;
 }
-/// \brief Set \c \@edges section to be read
+/// \brief Add an additional caption to the \c \@arcs section
 ///
-/// Set \c \@edges section to be read
+/// Add an additional caption to the \c \@arcs section.
 GraphWriter& edges(const std::string& caption) {
 _edges_caption = caption;
 return *this;
 }
-/// \brief Set \c \@attributes section to be read
+/// \brief Add an additional caption to the \c \@attributes section
 ///
-/// Set \c \@attributes section to be read
+/// Add an additional caption to the \c \@attributes section.
 GraphWriter& attributes(const std::string& caption) {
 _attributes_caption = caption;
 return *this;
 }
 /// \name Skipping section
 /// @{
 /// \brief Skip writing the node set
 ///
-/// The \c \@nodes section will be not written to the stream.
+/// The \c \@nodes section will not be written to the stream.
 GraphWriter& skipNodes() {
 LEMON_ASSERT(!_skip_nodes, "Multiple usage of skipNodes() member");
 _skip_nodes = true;
 return *this;
 }
 /// \brief Skip writing edge set
 ///
-/// The \c \@edges section will be not written to the stream.
+/// The \c \@edges section will not be written to the stream.
 GraphWriter& skipEdges() {
 LEMON_ASSERT(!_skip_edges, "Multiple usage of skipEdges() member");
 _skip_edges = true;
 return *this;
 }
 /// \name Execution of the writer
 /// @{
 /// \brief Start the batch processing
 ///
-/// This function starts the batch processing
+/// This function starts the batch processing.
 void run() {
 if (!_skip_nodes) {
 	writeNodes();
 } else {
 	createNodeIndex();
 	createEdgeIndex();
 }
 writeAttributes();
 }
-/// \brief Gives back the stream of the writer
+/// \brief Give back the stream of the writer
 ///
-/// Gives back the stream of the writer
+/// Give back the stream of the writer
 std::ostream& ostream() {
 return *_os;
 }
 /// @}
 };
+/// \brief Return a \ref GraphWriter class
+///
+/// This function just returns a \ref GraphWriter class.
 /// \relates GraphWriter
 template <typename Graph>
 GraphWriter<Graph> graphWriter(std::ostream& os, const Graph& graph) {
 GraphWriter<Graph> tmp(os, graph);
 return tmp;
 }
+/// \brief Return a \ref GraphWriter class
+///
+/// This function just returns a \ref GraphWriter class.
 /// \relates GraphWriter
 template <typename Graph>
 GraphWriter<Graph> graphWriter(const std::string& fn, const Graph& graph) {
 GraphWriter<Graph> tmp(fn, graph);
 return tmp;
 }
+/// \brief Return a \ref GraphWriter class
+///
+/// This function just returns a \ref GraphWriter class.
 /// \relates GraphWriter
 template <typename Graph>
 GraphWriter<Graph> graphWriter(const char* fn, const Graph& graph) {
 GraphWriter<Graph> tmp(fn, graph);
 return tmp;

changeset 195	aa45ff44fcf3
parent 190	1e6af6f0843c
child 197	5893bacaa720