Add some c++11 flags in documentation

This commit is contained in:
Gael Guennebaud 2016-05-19 17:35:30 +02:00
parent b6ed8244b4
commit ce12562710
3 changed files with 38 additions and 30 deletions

View File

@ -308,13 +308,13 @@ cosh() const
return CoshReturnType(derived()); return CoshReturnType(derived());
} }
/** \returns an expression of the coefficient-wise ln(|gamma(*this)|). /** \cpp11 \returns an expression of the coefficient-wise ln(|gamma(*this)|).
* *
* Example: \include Cwise_lgamma.cpp * Example: \include Cwise_lgamma.cpp
* Output: \verbinclude Cwise_lgamma.out * Output: \verbinclude Cwise_lgamma.out
* *
* \sa cos(), sin(), tan() * \sa cos(), sin(), tan()
*/ */
inline const LgammaReturnType inline const LgammaReturnType
lgamma() const lgamma() const
{ {
@ -322,9 +322,9 @@ lgamma() const
} }
/** \returns an expression of the coefficient-wise digamma (psi, derivative of lgamma). /** \returns an expression of the coefficient-wise digamma (psi, derivative of lgamma).
* *
* \sa cos(), sin(), tan() * \sa cos(), sin(), tan()
*/ */
inline const DigammaReturnType inline const DigammaReturnType
digamma() const digamma() const
{ {
@ -332,43 +332,43 @@ digamma() const
} }
/** \returns an expression of the coefficient-wise zeta function. /** \returns an expression of the coefficient-wise zeta function.
*/ */
inline const ZetaReturnType inline const ZetaReturnType
zeta() const zeta() const
{ {
return ZetaReturnType(derived()); return ZetaReturnType(derived());
} }
/** \returns an expression of the coefficient-wise polygamma function. /** \cpp11 \returns an expression of the coefficient-wise polygamma function.
*/ */
inline const PolygammaReturnType inline const PolygammaReturnType
polygamma() const polygamma() const
{ {
return PolygammaReturnType(derived()); return PolygammaReturnType(derived());
} }
/** \returns an expression of the coefficient-wise Gauss error /** \cpp11 \returns an expression of the coefficient-wise Gauss error
* function of *this. * function of *this.
* *
* Example: \include Cwise_erf.cpp * Example: \include Cwise_erf.cpp
* Output: \verbinclude Cwise_erf.out * Output: \verbinclude Cwise_erf.out
* *
* \sa cos(), sin(), tan() * \sa cos(), sin(), tan()
*/ */
inline const ErfReturnType inline const ErfReturnType
erf() const erf() const
{ {
return ErfReturnType(derived()); return ErfReturnType(derived());
} }
/** \returns an expression of the coefficient-wise Complementary error /** \cpp11 \returns an expression of the coefficient-wise Complementary error
* function of *this. * function of *this.
* *
* Example: \include Cwise_erfc.cpp * Example: \include Cwise_erfc.cpp
* Output: \verbinclude Cwise_erfc.out * Output: \verbinclude Cwise_erfc.out
* *
* \sa cos(), sin(), tan() * \sa cos(), sin(), tan()
*/ */
inline const ErfcReturnType inline const ErfcReturnType
erfc() const erfc() const
{ {

View File

@ -225,7 +225,10 @@ ALIASES = "only_for_vectors=This is only for vectors (either row-
"note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." \ "note_try_to_help_rvo=This function returns the result by value. In order to make that efficient, it is implemented as just a return statement using a special constructor, hopefully allowing the compiler to perform a RVO (return value optimization)." \
"nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\"" \ "nonstableyet=\warning This is not considered to be part of the stable public API yet. Changes may happen in future releases. See \ref Experimental \"Experimental parts of Eigen\"" \
"implsparsesolverconcept=This class follows the \link TutorialSparseSolverConcept sparse solver concept \endlink." \ "implsparsesolverconcept=This class follows the \link TutorialSparseSolverConcept sparse solver concept \endlink." \
"blank= " "blank= " \
"cpp11=<span class='cpp11'>[c++11]</a>" \
"cpp14=<span class='cpp14'>[c++14]</a>" \
"cpp17=<span class='cpp17'>[c++17]</a>"
ALIASES += "eigenAutoToc= " ALIASES += "eigenAutoToc= "

View File

@ -166,6 +166,11 @@ div.toc ul {
margin: 0.2em 0 0.4em 0.5em; margin: 0.2em 0 0.4em 0.5em;
} }
span.cpp11,span.cpp14,span.cpp17 {
color: #119911;
font-weight: bold;
}
/**** old Eigen's styles ****/ /**** old Eigen's styles ****/