COIN-OR::LEMON - Graph Library

Changeset 1630:f67737f5727a in lemon-0.x


Ignore:
Timestamp:
08/16/05 18:44:57 (19 years ago)
Author:
Alpar Juttner
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2138
Message:

Doc changes:

  • True and False got documented
  • Graph "developper interface" documentation switched off
  • minor fix in graph_to_eps_demo.cc
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • demo/graph_to_eps_demo.cc

    r1587 r1630  
    2525/// how to handle parallel egdes, how to change the properties (like
    2626/// color, shape, size, title etc.) of nodes and edges individually
    27 /// using appropriate \ref maps-page "graphmapfactory".
     27/// using appropriate \ref maps-page "graph maps".
    2828
    2929#include <cmath>
  • lemon/concept/graph.h

    r1627 r1630  
    428428      Node source(Edge) const { return INVALID; }
    429429
    430       /// Gives back the first Node in the iterating order.
    431      
    432       /// Gives back the first Node in the iterating order.
    433       ///     
     430//       /// Gives back the first Node in the iterating order.
     431     
     432//       /// Gives back the first Node in the iterating order.
     433//       ///     
    434434      void first(Node&) const {}
    435435
    436       /// Gives back the next Node in the iterating order.
    437      
    438       /// Gives back the next Node in the iterating order.
    439       ///     
     436//       /// Gives back the next Node in the iterating order.
     437     
     438//       /// Gives back the next Node in the iterating order.
     439//       ///     
    440440      void next(Node&) const {}
    441441
    442       /// Gives back the first Edge in the iterating order.
    443      
    444       /// Gives back the first Edge in the iterating order.
    445       ///     
     442//       /// Gives back the first Edge in the iterating order.
     443     
     444//       /// Gives back the first Edge in the iterating order.
     445//       ///     
    446446      void first(Edge&) const {}
    447       /// Gives back the next Edge in the iterating order.
    448      
    449       /// Gives back the next Edge in the iterating order.
    450       ///     
     447//       /// Gives back the next Edge in the iterating order.
     448     
     449//       /// Gives back the next Edge in the iterating order.
     450//       ///     
    451451      void next(Edge&) const {}
    452452
    453453
    454       /// Gives back the first of the Edges point to the given Node.
    455      
    456       /// Gives back the first of the Edges point to the given Node.
    457       ///     
     454//       /// Gives back the first of the Edges point to the given Node.
     455     
     456//       /// Gives back the first of the Edges point to the given Node.
     457//       ///     
    458458      void firstIn(Edge&, const Node&) const {}
    459459
    460       /// Gives back the next of the Edges points to the given Node.
    461 
    462 
    463       /// Gives back the next of the Edges points to the given Node.
    464       ///
     460//       /// Gives back the next of the Edges points to the given Node.
     461
     462
     463//       /// Gives back the next of the Edges points to the given Node.
     464//       ///
    465465      void nextIn(Edge&) const {}
    466466
    467       /// Gives back the first of the Edges start from the given Node.
    468      
    469       /// Gives back the first of the Edges start from the given Node.
    470       ///     
     467//       /// Gives back the first of the Edges start from the given Node.
     468     
     469//       /// Gives back the first of the Edges start from the given Node.
     470//       ///     
    471471      void firstOut(Edge&, const Node&) const {}
    472472
    473       /// Gives back the next of the Edges start from the given Node.
    474      
    475       /// Gives back the next of the Edges start from the given Node.
    476       ///     
     473//       /// Gives back the next of the Edges start from the given Node.
     474     
     475//       /// Gives back the next of the Edges start from the given Node.
     476//       ///     
    477477      void nextOut(Edge&) const {}
    478478
     
    512512      /// \warning Making maps that can handle bool type (NodeMap<bool>)
    513513      /// needs some extra attention!
     514      /// \todo Wrong documentation
    514515      template<class T>
    515516      class NodeMap : public ReadWriteMap< Node, T >
     
    535536      /// \warning Making maps that can handle bool type (EdgeMap<bool>)
    536537      /// needs some extra attention!
     538      /// \todo Wrong documentation
    537539      template<class T>
    538540      class EdgeMap : public ReadWriteMap<Edge,T>
  • lemon/concept/undir_graph.h

    r1627 r1630  
    3333  namespace concept {
    3434
    35     /// Skeleton class which describes an edge with direction in \ref
    36     /// UndirGraph "undirected graph".
     35//     /// Skeleton class which describes an edge with direction in \ref
     36//     /// UndirGraph "undirected graph".
    3737    template <typename UndirGraph>
    3838    class UndirGraphEdge : public UndirGraph::UndirEdge {
     
    675675      /// \warning Making maps that can handle bool type (NodeMap<bool>)
    676676      /// needs some extra attention!
     677      /// \todo Wrong documentation
    677678      template<class T>
    678679      class NodeMap : public ReadWriteMap< Node, T >
     
    698699      /// \warning Making maps that can handle bool type (EdgeMap<bool>)
    699700      /// needs some extra attention!
     701      /// \todo Wrong documentation
    700702      template<class T>
    701703      class EdgeMap : public ReadWriteMap<Edge,T>
     
    720722      /// \warning Making maps that can handle bool type (UndirEdgeMap<bool>)
    721723      /// needs some extra attention!
     724      /// \todo Wrong documentation
    722725      template<class T>
    723726      class UndirEdgeMap : public ReadWriteMap<UndirEdge,T>
     
    791794      Node target(Edge) const { return INVALID; }
    792795
    793       /// \brief First node of the graph
    794       ///
    795       /// \note This method is part of so called \ref
    796       /// developpers_interface "Developpers' interface", so it shouldn't
    797       /// be used in an end-user program.
     796//       /// \brief First node of the graph
     797//       ///
     798//       /// \note This method is part of so called \ref
     799//       /// developpers_interface "Developpers' interface", so it shouldn't
     800//       /// be used in an end-user program.
    798801      void first(Node&) const {}
    799       /// \brief Next node of the graph
    800       ///
    801       /// \note This method is part of so called \ref
    802       /// developpers_interface "Developpers' interface", so it shouldn't
    803       /// be used in an end-user program.
     802//       /// \brief Next node of the graph
     803//       ///
     804//       /// \note This method is part of so called \ref
     805//       /// developpers_interface "Developpers' interface", so it shouldn't
     806//       /// be used in an end-user program.
    804807      void next(Node&) const {}
    805808
    806       /// \brief First undirected edge of the graph
    807       ///
    808       /// \note This method is part of so called \ref
    809       /// developpers_interface "Developpers' interface", so it shouldn't
    810       /// be used in an end-user program.
     809//       /// \brief First undirected edge of the graph
     810//       ///
     811//       /// \note This method is part of so called \ref
     812//       /// developpers_interface "Developpers' interface", so it shouldn't
     813//       /// be used in an end-user program.
    811814      void first(UndirEdge&) const {}
    812       /// \brief Next undirected edge of the graph
    813       ///
    814       /// \note This method is part of so called \ref
    815       /// developpers_interface "Developpers' interface", so it shouldn't
    816       /// be used in an end-user program.
     815//       /// \brief Next undirected edge of the graph
     816//       ///
     817//       /// \note This method is part of so called \ref
     818//       /// developpers_interface "Developpers' interface", so it shouldn't
     819//       /// be used in an end-user program.
    817820      void next(UndirEdge&) const {}
    818821
    819       /// \brief First directed edge of the graph
    820       ///
    821       /// \note This method is part of so called \ref
    822       /// developpers_interface "Developpers' interface", so it shouldn't
    823       /// be used in an end-user program.
     822//       /// \brief First directed edge of the graph
     823//       ///
     824//       /// \note This method is part of so called \ref
     825//       /// developpers_interface "Developpers' interface", so it shouldn't
     826//       /// be used in an end-user program.
    824827      void first(Edge&) const {}
    825       /// \brief Next directed edge of the graph
    826       ///
    827       /// \note This method is part of so called \ref
    828       /// developpers_interface "Developpers' interface", so it shouldn't
    829       /// be used in an end-user program.
     828//       /// \brief Next directed edge of the graph
     829//       ///
     830//       /// \note This method is part of so called \ref
     831//       /// developpers_interface "Developpers' interface", so it shouldn't
     832//       /// be used in an end-user program.
    830833      void next(Edge&) const {}
    831834
    832       /// \brief First outgoing edge from a given node
    833       ///
    834       /// \note This method is part of so called \ref
    835       /// developpers_interface "Developpers' interface", so it shouldn't
    836       /// be used in an end-user program.
     835//       /// \brief First outgoing edge from a given node
     836//       ///
     837//       /// \note This method is part of so called \ref
     838//       /// developpers_interface "Developpers' interface", so it shouldn't
     839//       /// be used in an end-user program.
    837840      void firstOut(Edge&, Node) const {}
    838       /// \brief Next outgoing edge to a node
    839       ///
    840       /// \note This method is part of so called \ref
    841       /// developpers_interface "Developpers' interface", so it shouldn't
    842       /// be used in an end-user program.
     841//       /// \brief Next outgoing edge to a node
     842//       ///
     843//       /// \note This method is part of so called \ref
     844//       /// developpers_interface "Developpers' interface", so it shouldn't
     845//       /// be used in an end-user program.
    843846      void nextOut(Edge&) const {}
    844847
    845       /// \brief First incoming edge to a given node
    846       ///
    847       /// \note This method is part of so called \ref
    848       /// developpers_interface "Developpers' interface", so it shouldn't
    849       /// be used in an end-user program.
     848//       /// \brief First incoming edge to a given node
     849//       ///
     850//       /// \note This method is part of so called \ref
     851//       /// developpers_interface "Developpers' interface", so it shouldn't
     852//       /// be used in an end-user program.
    850853      void firstIn(Edge&, Node) const {}
    851       /// \brief Next incoming edge to a node
    852       ///
    853       /// \note This method is part of so called \ref
    854       /// developpers_interface "Developpers' interface", so it shouldn't
    855       /// be used in an end-user program.
     854//       /// \brief Next incoming edge to a node
     855//       ///
     856//       /// \note This method is part of so called \ref
     857//       /// developpers_interface "Developpers' interface", so it shouldn't
     858//       /// be used in an end-user program.
    856859      void nextIn(Edge&) const {}
    857860
  • lemon/utility.h

    r1447 r1630  
    4444{
    4545
    46   /// Basic type for defining "tags". A "YES" condition for enable_if.
     46  /// Basic type for defining "tags". A "YES" condition for \c enable_if.
    4747
     48  /// Basic type for defining "tags". A "YES" condition for \c enable_if.
     49  ///
     50  ///\sa False
     51  ///
    4852  /// \todo This should go to a separate "basic_types.h" (or something)
    4953  /// file.
    5054  struct True {
     55    ///\e
    5156    static const bool value = true;
    5257  };
    5358
    54   /// Basic type for defining "tags". A "NO" condition for enable_if.
     59  /// Basic type for defining "tags". A "NO" condition for \c enable_if.
     60
     61  /// Basic type for defining "tags". A "NO" condition for \c enable_if.
     62  ///
     63  ///\sa True
    5564  struct False {
     65    ///\e
    5666    static const bool value = false;
    5767  };
Note: See TracChangeset for help on using the changeset viewer.