Commit caf9a708 by Jason Rhinelander

Documentation fixes

`Doxygen found some doc errors/undocumented items.  Fixed.`
parent 78c9f724
 ... ... @@ -121,7 +121,7 @@ class Equation::Proxy final { /// Appends another variable to the model; see Equation::operator<< template ::value and std::is_move_constructible::value>::type> Proxy& operator + (V &&var); Proxy& operator + (V &&var) { eq_.addVar(std::move(var)); return *this; } private: Equation &eq_; Proxy(Equation &eq); ... ... @@ -145,12 +145,6 @@ Equation::Proxy Equation::operator % (V &&var) { return Proxy(*this); } template Equation::Proxy& Equation::Proxy::operator + (V &&var) { eq_.addVar(std::move(var)); return *this; } /// Specialization for a ConstantVariable template <> void Equation::addVar(ConstantVariable &&v); ... ...
 ... ... @@ -4,6 +4,7 @@ namespace creativity { namespace data { /** Class for running a basic OLS regression. */ class OLS { public: /// No default constructor ... ... @@ -42,7 +43,7 @@ class OLS { /// Returns the covariance estimate of the beta estimators const Eigen::MatrixXd& covariance(); /// Returns the regression standard error, \fs^2\f /// Returns the regression standard error, \f\$^2\f\$ const double& s2(); /// Returns the residuals ... ...
 ... ... @@ -8,6 +8,7 @@ namespace creativity { namespace data { */ class RankError : public std::runtime_error { public: /// Constructor; takes an exception message RankError(const std::string &message) : std::runtime_error(message) {} }; ... ...
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!