Skip to content
Snippets Groups Projects
Commit 82544861 authored by René Fritze's avatar René Fritze
Browse files

[all] documentation updates

parent f7ebb47d
No related branches found
No related tags found
No related merge requests found
...@@ -197,7 +197,7 @@ protected: ...@@ -197,7 +197,7 @@ protected:
boost::accumulators::accumulator_set<ElementType, StatsType> acc_; boost::accumulators::accumulator_set<ElementType, StatsType> acc_;
}; };
//! bound \param var in [\param min,\param max] //! \return var bounded in [min, max]
template <typename T> template <typename T>
T clamp(const T var, const T min, const T max) T clamp(const T var, const T min, const T max)
{ {
......
...@@ -175,8 +175,7 @@ private: ...@@ -175,8 +175,7 @@ private:
return pf; return pf;
} }
/** output to \param filename /** output to \param filename filename
* \tparam CollectiveCommunication should be Dune::CollectiveCommunication< MPI_Comm / double >
**/ **/
void outputCommon(const InfoContainer& run_infos, const boost::filesystem::path& filename, void outputCommon(const InfoContainer& run_infos, const boost::filesystem::path& filename,
const double scale_factor = 1.0) const; const double scale_factor = 1.0) const;
......
...@@ -51,7 +51,7 @@ inline std::string toString(const ReturnType& s) ...@@ -51,7 +51,7 @@ inline std::string toString(const ReturnType& s)
\brief Returns a string of lengths s' whitespace (or c chars). \brief Returns a string of lengths s' whitespace (or c chars).
\param[in] s \param[in] s
std::string, defines the length of the return string std::string, defines the length of the return string
\param[in] c \param[in] whitespace
char, optional argument, defines entries of return string char, optional argument, defines entries of return string
\return std::string \return std::string
Returns a string of lengths s' whitespace (or c chars). Returns a string of lengths s' whitespace (or c chars).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment