COIN-OR::LEMON - Graph Library

Changeset 2370:ed6539025f27 in lemon-0.x for lemon


Ignore:
Timestamp:
02/19/07 19:56:11 (13 years ago)
Author:
Balazs Dezso
Branch:
default
Phase:
public
Convert:
svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@3185
Message:

Some documentation changes

Location:
lemon
Files:
9 edited

Legend:

Unmodified
Added
Removed
  • lemon/lp.h

    r2312 r2370  
    3535///\file
    3636///\brief Defines a default LP solver
    37 ///\ingroup gen_opt_group
     37///\ingroup lp_group
    3838namespace lemon {
    3939
     
    4242
    4343  ///The default LP solver identifier.
    44   ///\ingroup gen_opt_group
     44  ///\ingroup lp_group
    4545  ///
    4646  ///Currently, the possible values are \c GLPK or \c CPLEX
     
    4949
    5050  ///The default LP solver.
    51   ///\ingroup gen_opt_group
     51  ///\ingroup lp_group
    5252  ///
    5353  ///Currently, it is either \c LpGlpk or \c LpCplex
     
    5656
    5757  ///The default LP solver identifier string.
    58   ///\ingroup gen_opt_group
     58  ///\ingroup lp_group
    5959  ///
    6060  ///Currently, the possible values are "GLPK" or "CPLEX"
     
    6464
    6565  ///The default ILP solver.
    66   ///\ingroup gen_opt_group
     66  ///\ingroup lp_group
    6767  ///
    6868  ///Currently, it is either \c LpGlpk or \c LpCplex
  • lemon/lp_base.h

    r2369 r2370  
    3535///\file
    3636///\brief The interface of the LP solver interface.
    37 ///\ingroup gen_opt_group
     37///\ingroup lp_group
    3838namespace lemon {
    3939
     
    4141 
    4242  ///\todo Much more docs
    43   ///\ingroup gen_opt_group
     43  ///\ingroup lp_group
    4444  class LpSolverBase {
    4545
     
    13771377
    13781378
    1379   ///Common base class for MIP solvers
    1380   ///\todo Much more docs
    1381   ///\ingroup gen_opt_group
     1379  /// \ingroup lp_group
     1380  ///
     1381  /// \brief Common base class for MIP solvers
     1382  /// \todo Much more docs
    13821383  class MipSolverBase : virtual public LpSolverBase{
    13831384  public:
  • lemon/lp_glpk.h

    r2366 r2370  
    2222///\file
    2323///\brief Header of the LEMON-GLPK lp solver interface.
    24 ///\ingroup gen_opt_group
     24///\ingroup lp_group
    2525
    2626#include <lemon/lp_base.h>
     
    3535  ///
    3636  /// This class implements an interface for the GLPK LP solver.
    37   ///\ingroup gen_opt_group
     37  ///\ingroup lp_group
    3838  class LpGlpk : virtual public LpSolverBase {
    3939  protected:
  • lemon/lp_soplex.h

    r2366 r2370  
    3535namespace lemon {
    3636
    37   /// \ingroup gen_opt_group
     37  /// \ingroup lp_group
    3838  ///
    3939  /// \brief Interface for the SOPLEX solver
  • lemon/lp_utils.h

    r2369 r2370  
    3131namespace lemon {
    3232
    33   /// \ingroup gen_opt_tools
     33  /// \ingroup lp_utils
    3434  ///
    3535  /// \brief The map for the result of the lp variables.
     
    5252  };
    5353
    54   /// \ingroup gen_opt_tools
     54  /// \ingroup lp_utils
     55  ///
     56  /// \brief Returns an \ref LpResultMap class
     57  ///
     58  /// This function just returns an \ref LpResultMap class.
     59  /// \relates LpResultMap
     60  LpResultMap lpResultMap(const LpSolverBase& lp) {
     61    return LpResultMap(lp);
     62  }
     63
     64  /// \ingroup lp_utils
    5565  ///
    5666  /// \brief The map for the name of the lp variables.
     
    7383  };
    7484
    75   /// \ingroup gen_opt_tools
     85  /// \ingroup lp_utils
    7686  ///
    7787  /// \brief Writeable map for the name of the lp variables.
     
    97107  };
    98108
    99   /// \ingroup gen_opt_tools
     109  /// \ingroup lp_utils
    100110  ///
    101111  /// \brief Returns an \ref LpColNameMap class
     
    111121  }
    112122
    113   /// \ingroup gen_opt_tools
     123  /// \ingroup lp_utils
    114124  ///
    115125  /// \brief Lp variable item reader for Lemon IO
     
    198208  };
    199209
    200   /// \ingroup gen_opt_tools
     210  /// \ingroup lp_utils
    201211  ///
    202212  /// \brief Lp variable item writer for Lemon IO
     
    264274  };
    265275
    266   /// \ingroup gen_opt_tools
     276  /// \ingroup lp_utils
    267277  ///
    268278  /// \brief Lp section reader for lemon IO
     
    744754
    745755
    746   /// \ingroup gen_opt_tools
     756  /// \ingroup lp_utils
    747757  ///
    748758  /// \brief Lp section writer for lemon IO
  • lemon/mip_cplex.h

    r2366 r2370  
    2222///\file
    2323///\brief Header of the LEMON-CPLEX mip solver interface.
    24 ///\ingroup gen_opt_group
     24///\ingroup lp_group
    2525
    2626
     
    3232  ///
    3333  /// This class implements an interface for the CPLEX MIP solver.
    34   ///\ingroup gen_opt_group
     34  ///\ingroup lp_group
    3535  class MipCplex : public MipSolverBase, public LpCplex{
    3636   
  • lemon/mip_glpk.h

    r2366 r2370  
    2222///\file
    2323///\brief Header of the LEMON-GLPK mip solver interface.
    24 ///\ingroup gen_opt_group
     24///\ingroup lp_group
    2525
    2626
     
    3131  ///
    3232  /// This class implements an interface for the GLPK MIP solver.
    33   ///\ingroup gen_opt_group
     33  ///\ingroup lp_group
    3434  class MipGlpk : public MipSolverBase, public LpGlpk{
    3535 
  • lemon/simann.h

    r2304 r2370  
    3535
    3636namespace lemon {
    37 
    38 /// \addtogroup experimental
    39 /// @{
    4037
    4138  class SimAnnBase;
     
    173170  };
    174171
     172  /// \ingroup metah
     173  ///
    175174  /// \brief Simulated annealing class.
    176175  class SimAnn : public SimAnnBase {
     
    376375  };
    377376
    378 /// @}
    379 
    380377}
    381378
  • lemon/tabu_search.h

    r2151 r2370  
    2121#define LEMON_TABU_SEARCH_H
    2222
    23 /// \ingroup experimental
     23/// \ingroup metah
    2424/// \file
    2525/// \brief TabuSearch algorithm.
     
    308308
    309309
     310  /// \ingroup metah
     311  ///
    310312  /// \brief TabuSearch main class
    311313  ///
Note: See TracChangeset for help on using the changeset viewer.