fix doxygen warnings; exclude fmt from docu

doc/soplex.dxy

@@ -824,7 +824,7 @@ RECURSIVE = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE =
+EXCLUDE = ../src/soplex/external/
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1643,7 +1643,7 @@ COMPACT_LATEX = YES
 # The default value is: a4.
 # This tag requires that the tag GENERATE_LATEX is set to YES.
 
-PAPER_TYPE = a4wide
+PAPER_TYPE =
 
 # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
 # that should be included in the LaTeX output. The package can be specified just
@@ -2423,4 +2423,4 @@ GENERATE_LEGEND = YES
 # The default value is: YES.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_CLEANUP = YES
+DOT_CLEANUP = YES

doc/xternal.cpp

@@ -299,7 +299,7 @@
  * <TR><TD>coVector</TD><TD>colVector</TD><TD>rowVector</TD></TR>
  * </TABLE>
  *
- * Whether the \ref soplex::SPxBasis::Desc::Status "SPxBasis::Desc::Status" of a
+ * Whether the \ref soplex::SPxBasisBase::Desc::Status "SPxBasisBase::Desc::Status" of a
  * variable indicates that the corresponding vector is in the basis matrix or
  * not also depends on the chosen representation. Hence, methods \c isBasic()
  * are provided to get the correct answer for both representations.

src/soplex/classset.h

@@ -137,8 +137,6 @@ class ClassSet
  *newelem = item;
  }
  /// adds element \p item.
- /**@return 0 on success and non-zero, if an error occured.
- */
  void add(const T& item)
  {
  T* newelem = create();

src/soplex/clufactor.h

@@ -485,7 +485,8 @@ class CLUFactor
  ///
  void factor(const SVectorBase<R>** vec, ///< Array of column VectorBase<R> pointers
  R threshold, ///< pivoting threshold
- R eps); ///< epsilon for zero detection
+ R eps ///< epsilon for zero detection
+ );
  ///@}
 
  //----------------------------------------

src/soplex/clufactor_rational.h

@@ -449,7 +449,8 @@ class CLUFactorRational
 
  ///
  void factor(const SVectorRational** vec, ///< Array of column vector pointers
- const Rational& threshold); ///< pivoting threshold
+ const Rational& threshold ///< pivoting threshold
+ );
  ///@}
 
  //----------------------------------------

src/soplex/dataset.h

@@ -141,8 +141,6 @@ class DataSet
  *data = item;
  }
  /// adds element \p item.
- /**@return 0 on success and non-zero, if an error occured.
- */
  void add(const DATA& item)
  {
  DATA* data = create();

src/soplex/lprowbase.h

@@ -40,7 +40,7 @@ namespace soplex
  *
  * Class LPRowBase provides constraints for linear programs in the form \f[ l \le a^Tx \le r, \f] where \em a is a
  * DSVector. \em l is referred to as %left hand side, \em r as %right hand side and \em a as \em row \em vector or the
- * constraint vector. \em l and \em r may also take values \f$\pm\f$ #R(infinity). This static member is predefined, but
+ * constraint vector. \em l and \em r may also take values \f$\pm\f$ R(infinity). This static member is predefined, but
  * may be overridden to meet the needs of the LP solver to be used.
  *
  * LPRowBases allow to specify regular inequalities of the form \f[ a^Tx \sim \alpha, \f] where \f$\sim\f$ can take any

src/soplex/lprowsetbase.h

@@ -656,6 +656,7 @@ class LPRowSetBase : protected SVSetBase<R>
 
  // ------------------------------------------------------------------------------------------------------------------
  /**@name Consistency check */
+ ///@{
 
  /// Checks consistency.
  bool isConsistent() const

src/soplex/slinsolver.h

@@ -45,8 +45,8 @@ namespace soplex
 
  Class SLinSolver provides a class for solving sparse linear systems with
  a matrix \f$A\f$ and arbitrary right-hand side vectors. For doing so, the
- matrix must be first #load%ed to an #SLinSolver object as an array of
- pointers to the \em column \ref SVectorBase<R> "SVectors" of this matrix.
+ matrix must be first #load%ed to an SLinSolver object as an array of
+ pointers to the \em column \ref soplex::SVectorBase<R> "SVectors" of this matrix.
 */
 template <class R>
 class SLinSolver

src/soplex/spxharrisrt.h

@@ -59,26 +59,26 @@ class SPxHarrisRT : public SPxRatioTester<R>
 
  ///
  int maxDelta(
- R* /*max*/, ///< max abs value in \p upd
+ R* /*max*/, ///< max abs value in upd
  R* val, ///< initial and chosen value
- int num, ///< number of indices in \p idx
- const int* idx, ///< nonzero indices in \p upd
- const R* upd, ///< update VectorBase<R> for \p vec
+ int num, ///< number of indices in idx
+ const int* idx, ///< nonzero indices in upd
+ const R* upd, ///< update VectorBase<R> for vec
  const R* vec, ///< current vector
- const R* low, ///< lower bounds for \p vec
- const R* up ///< upper bounds for \p vec
+ const R* low, ///< lower bounds for vec
+ const R* up ///< upper bounds for vec
  ) const;
 
  ///
  int minDelta(
- R* /*max*/, ///< max abs value in \p upd
+ R* /*max*/, ///< max abs value in upd
  R* val, ///< initial and chosen value
- int num, ///< of indices in \p idx
- const int* idx, ///< nonzero indices in \p upd
- const R* upd, ///< update VectorBase<R> for \p vec
+ int num, ///< of indices in idx
+ const int* idx, ///< nonzero indices in upd
+ const R* upd, ///< update VectorBase<R> for vec
  const R* vec, ///< current vector
- const R* low, ///< lower bounds for \p vec
- const R* up ///< upper bounds for \p vec
+ const R* low, ///< lower bounds for vec
+ const R* up ///< upper bounds for vec
  ) const;
  ///@}
 

src/soplex/spxout.h

@@ -235,8 +235,8 @@ class SPxOut
 /**@name Verbosity manipulator
  Manipulators are implemented in a similar way as done for @c setw(),
  @c setprecision(), etc. in the standard library file iomanip. For
- instance, the non-member function \ref verb() "verb(v)" returns a
- struct struct_Severity which contains only the verbosity level.
+ instance, the non-member function \ref soplex::verb() "verb(v)"
+ returns a struct struct_Verbosity which contains only the verbosity level.
  Calling
  @code
  SPxOut spxout;
@@ -246,7 +246,7 @@ class SPxOut
  extracts the verbosity level from the struct and passes it to the
  member function SPxOut::setVerbosity().
 */
-//@{
+///@{
 /// manipulator to be used in an output statement
 inline SPxOut::struct_Verbosity
 verb(const SPxOut::Verbosity& v)
@@ -274,7 +274,7 @@ operator<< (SPxOut& stream,
  * other. When using only a template type, it is not clear what the
  * compiler makes out of it (according to lint).
  */
-//@{
+///@{
 ///
 /// Passes instances of type \p Type to the current stream.
 inline SPxOut& operator<< (SPxOut& _spxout, long t)
@@ -364,7 +364,7 @@ inline SPxOut& operator<< (SPxOut& _spxout, T t)
  return _spxout;
 }
 
-//@}
+///@}
 
 } // namespace soplex
 

src/soplex/spxpricer.h

@@ -188,7 +188,7 @@ class SPxPricer
  /// returns selected index to leave basis.
  /** Selects the index of a vector to leave the basis. The selected index
  i, say, must be in the range 0 <= i < solver()->dim() and its
- tested value must fullfill solver()->test()[i] < -#tolerance().
+ tested value must fullfill solver()->test()[i] < -#pricingTolerance().
  */
  virtual int selectLeave() = 0;
 
@@ -209,7 +209,7 @@ class SPxPricer
  /** Selects the SPxId of a vector to enter the basis. The selected
  id, must not represent a basic index (i.e. solver()->isBasic(id) must
  be false). However, the corresponding test value needs not to be less
- than -#tolerance(). If not, SoPlex will discard the pivot.
+ than -#pricingTolerance(). If not, SoPlex will discard the pivot.
 
  Note:
  When method #selectEnter() is called by the loaded SoPlex

src/soplex/ssvectorbase.h

@@ -46,7 +46,7 @@ template < class R > class SVSetBase;
  * @ingroup Algebra
  *
  * This class implements semi-sparse vectors. Such are #VectorBase%s where the indices of its nonzero elements can be
- * stored in an extra IdxSet. Only elements with absolute value > #epsilon are considered to be nonzero. Since really
+ * stored in an extra IdxSet. Only elements with absolute value > #getEpsilon() are considered to be nonzero. Since really
  * storing the nonzeros is not always convenient, an SSVectorBase provides two different stati: setup and not setup.
  * An SSVectorBase being setup means that the nonzero indices are available, otherwise an SSVectorBase is just an
  * ordinary VectorBase with an empty IdxSet. Note that due to arithmetic operation, zeros can slip in, i.e., it is
@@ -141,7 +141,7 @@ class SSVectorBase : public VectorBase<R>, protected IdxSet
  setupStatus = false;
  }
 
- /// Initializes nonzero indices for elements with absolute values above #epsilon and sets all other elements to 0.
+ /// Initializes nonzero indices for elements with absolute values above epsilon and sets all other elements to 0.
  void setup()
  {
  if(!isSetup())

src/soplex/svsetbase.h

@@ -363,7 +363,7 @@ class SVSetBase : protected ClassArray < Nonzero<R> >
  /** Adds SVectorBase \p svec to the %set. This includes copying its nonzeros to the sets nonzero memory and creating
  * an additional SVectorBase entry in vector memory. If neccessary, the memory blocks are enlarged appropriately.
  *
- * @return \p nkey contains the DataKey, that the SVSetBase has assosicated to the new SVectorBase.
+ * At return, \p nkey contains the DataKey, that the SVSetBase has assosicated to the new SVectorBase.
  */
  void add(DataKey& nkey, const SVectorBase<R>& svec)
  {
@@ -379,7 +379,7 @@ class SVSetBase : protected ClassArray < Nonzero<R> >
  /** Adds SVectorBase \p svec to the %set. This includes copying its nonzeros to the sets nonzero memory and creating
  * an additional SVectorBase entry in vector memory. If neccessary, the memory blocks are enlarged appropriately.
  *
- * @return \p nkey contains the DataKey, that the SVSetBase has assosicated to the new SVectorBase.
+ * At return, \p nkey contains the DataKey, that the SVSetBase has assosicated to the new SVectorBase.
  */
  template < class S >
  void add(DataKey& nkey, const S* rowValues, const int* rowIndices, int rowSize)
@@ -419,7 +419,7 @@ class SVSetBase : protected ClassArray < Nonzero<R> >
  /// Adds n SVectorBase%s to SVSetBase.
  /** Adds all \p n SVectorBase%s in the array \p svec to the %set.
  *
- * @return \p nkey contains the DataKey%s, that the SVSetBase has assosicated to the new SVectorBase%s.
+ * At return, nkey contains the DataKey%s, that the SVSetBase has assosicated to the new SVectorBase%s.
  *
  * @pre \p nkey must be large enough to fit \p n DataKey%s.
  */
@@ -454,7 +454,7 @@ class SVSetBase : protected ClassArray < Nonzero<R> >
  /// Adds all SVectorBase%s of \p pset to SVSetBase.
  /** Adds all \p n SVectorBase%s in the \p pset to an SVSetBase.
  *
- * @return \p nkey contains the DataKey%s, that the SVSetBase has assosicated to the new SVectorBase%s.
+ * At return, \p nkey contains the DataKey%s, that the SVSetBase has assosicated to the new SVectorBase%s.
  *
  * @pre \p nkey must be large enough to fit \p pset.num() DataKey%s.
  */
@@ -721,7 +721,7 @@ class SVSetBase : protected ClassArray < Nonzero<R> >
  /** Removes \p n SVectorBase%s from %set.
  * @pre \p nums must be at least of size \p n
  * @pre \p perm must be at least of size num()
- * @return \p perm is the permutations resulting from this removal: \p perm[i] < 0 indicates
+ * At return, \p perm is the permutations resulting from this removal: \p perm[i] < 0 indicates
  * that the element to index \p i has been removed. Otherwise, \p perm[i] is the new
  * index of the element with index \p i before the removal.
  */