Change the style of code examples in API doc
authorPeter Kovacs <kpeter@inf.elte.hu>
Sat, 07 Oct 2017 00:19:19 +0200 (2017-10-06)
changeset 11617d32a2d6ed59
parent 1160 bc571f16e1e9
child 1162 881e4168c65f
Change the style of code examples in API doc
lemon/lgf_reader.h
lemon/lgf_writer.h
     1.1 --- a/lemon/lgf_reader.h	Tue Sep 19 15:23:43 2017 +0200
     1.2 +++ b/lemon/lgf_reader.h	Sat Oct 07 00:19:19 2017 +0200
     1.3 @@ -451,13 +451,13 @@
     1.4    /// rules.
     1.5    ///
     1.6    ///\code
     1.7 -  /// DigraphReader<DGR>(digraph, std::cin).
     1.8 -  ///   nodeMap("coordinates", coord_map).
     1.9 -  ///   arcMap("capacity", cap_map).
    1.10 -  ///   node("source", src).
    1.11 -  ///   node("target", trg).
    1.12 -  ///   attribute("caption", caption).
    1.13 -  ///   run();
    1.14 +  /// DigraphReader<DGR>(digraph, std::cin)
    1.15 +  ///   .nodeMap("coordinates", coord_map)
    1.16 +  ///   .arcMap("capacity", cap_map)
    1.17 +  ///   .node("source", src)
    1.18 +  ///   .node("target", trg)
    1.19 +  ///   .attribute("caption", caption)
    1.20 +  ///   .run();
    1.21    ///\endcode
    1.22    ///
    1.23    /// By default, the reader uses the first section in the file of the
    1.24 @@ -1246,11 +1246,11 @@
    1.25    ///ListDigraph digraph;
    1.26    ///ListDigraph::ArcMap<int> cap(digraph);
    1.27    ///ListDigraph::Node src, trg;
    1.28 -  ///digraphReader(digraph, std::cin).
    1.29 -  ///  arcMap("capacity", cap).
    1.30 -  ///  node("source", src).
    1.31 -  ///  node("target", trg).
    1.32 -  ///  run();
    1.33 +  ///digraphReader(digraph, std::cin)
    1.34 +  ///  .arcMap("capacity", cap)
    1.35 +  ///  .node("source", src)
    1.36 +  ///  .node("target", trg)
    1.37 +  ///  .run();
    1.38    ///\endcode
    1.39    ///
    1.40    /// For a complete documentation, please see the
    1.41 @@ -2123,9 +2123,9 @@
    1.42    ///\code
    1.43    ///ListGraph graph;
    1.44    ///ListGraph::EdgeMap<int> weight(graph);
    1.45 -  ///graphReader(graph, std::cin).
    1.46 -  ///  edgeMap("weight", weight).
    1.47 -  ///  run();
    1.48 +  ///graphReader(graph, std::cin)
    1.49 +  ///  .edgeMap("weight", weight)
    1.50 +  ///  .run();
    1.51    ///\endcode
    1.52    ///
    1.53    /// For a complete documentation, please see the
    1.54 @@ -3191,9 +3191,9 @@
    1.55    ///\code
    1.56    ///ListBpGraph graph;
    1.57    ///ListBpGraph::EdgeMap<int> weight(graph);
    1.58 -  ///bpGraphReader(graph, std::cin).
    1.59 -  ///  edgeMap("weight", weight).
    1.60 -  ///  run();
    1.61 +  ///bpGraphReader(graph, std::cin)
    1.62 +  ///  .edgeMap("weight", weight)
    1.63 +  ///  .run();
    1.64    ///\endcode
    1.65    ///
    1.66    /// For a complete documentation, please see the
     2.1 --- a/lemon/lgf_writer.h	Tue Sep 19 15:23:43 2017 +0200
     2.2 +++ b/lemon/lgf_writer.h	Sat Oct 07 00:19:19 2017 +0200
     2.3 @@ -408,15 +408,15 @@
     2.4    /// arc() functions are used to add attribute writing rules.
     2.5    ///
     2.6    ///\code
     2.7 -  /// DigraphWriter<DGR>(digraph, std::cout).
     2.8 -  ///   nodeMap("coordinates", coord_map).
     2.9 -  ///   nodeMap("size", size).
    2.10 -  ///   nodeMap("title", title).
    2.11 -  ///   arcMap("capacity", cap_map).
    2.12 -  ///   node("source", src).
    2.13 -  ///   node("target", trg).
    2.14 -  ///   attribute("caption", caption).
    2.15 -  ///   run();
    2.16 +  /// DigraphWriter<DGR>(digraph, std::cout)
    2.17 +  ///   .nodeMap("coordinates", coord_map)
    2.18 +  ///   .nodeMap("size", size)
    2.19 +  ///   .nodeMap("title", title)
    2.20 +  ///   .arcMap("capacity", cap_map)
    2.21 +  ///   .node("source", src)
    2.22 +  ///   .node("target", trg)
    2.23 +  ///   .attribute("caption", caption)
    2.24 +  ///   .run();
    2.25    ///\endcode
    2.26    ///
    2.27    ///
    2.28 @@ -961,11 +961,11 @@
    2.29    ///ListDigraph::ArcMap<int> cap(digraph);
    2.30    ///ListDigraph::Node src, trg;
    2.31    ///  // Setting the capacity map and source and target nodes
    2.32 -  ///digraphWriter(digraph, std::cout).
    2.33 -  ///  arcMap("capacity", cap).
    2.34 -  ///  node("source", src).
    2.35 -  ///  node("target", trg).
    2.36 -  ///  run();
    2.37 +  ///digraphWriter(digraph, std::cout)
    2.38 +  ///  .arcMap("capacity", cap)
    2.39 +  ///  .node("source", src)
    2.40 +  ///  .node("target", trg)
    2.41 +  ///  .run();
    2.42    ///\endcode
    2.43    ///
    2.44    /// For a complete documentation, please see the
    2.45 @@ -1599,9 +1599,9 @@
    2.46    ///ListGraph graph;
    2.47    ///ListGraph::EdgeMap<int> weight(graph);
    2.48    ///  // Setting the weight map
    2.49 -  ///graphWriter(graph, std::cout).
    2.50 -  ///  edgeMap("weight", weight).
    2.51 -  ///  run();
    2.52 +  ///graphWriter(graph, std::cout)
    2.53 +  ///  .edgeMap("weight", weight)
    2.54 +  ///  .run();
    2.55    ///\endcode
    2.56    ///
    2.57    /// For a complete documentation, please see the
    2.58 @@ -2419,9 +2419,9 @@
    2.59    ///ListBpGraph graph;
    2.60    ///ListBpGraph::EdgeMap<int> weight(graph);
    2.61    ///  // Setting the weight map
    2.62 -  ///bpGraphWriter(graph, std::cout).
    2.63 -  ///  edgeMap("weight", weight).
    2.64 -  ///  run();
    2.65 +  ///bpGraphWriter(graph, std::cout)
    2.66 +  ///  .edgeMap("weight", weight)
    2.67 +  ///  .run();
    2.68    ///\endcode
    2.69    ///
    2.70    /// For a complete documentation, please see the