More documentations fixes

jfalcou · Nov 29, 2024 · b7eaa87 · b7eaa87
1 parent 7521486
commit b7eaa87
Show file tree

Hide file tree

Showing 10 changed files with 39 additions and 4 deletions.
diff --git a/include/kyosu/constants/cinf.hpp b/include/kyosu/constants/cinf.hpp
@@ -65,6 +65,10 @@ namespace kyosu
 //!   **Return value**
 //!
 //!     * always returns a cayley_dickson value such that real(i) is a NaN and imag(i) is \f$+\infty\f$ (the remaining parts being 0).
+//!       This is meant to represent a quantity with infinite magnitude, but undetermined complex phase.
+//!
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: complex infinity](https://reference.wolfram.com/language/ref/ComplexInfinity.html)
 //!
 //!  @groupheader{Example}
 //!

diff --git a/include/kyosu/functions/beta.hpp b/include/kyosu/functions/beta.hpp
@@ -55,13 +55,16 @@ namespace kyosu
 //!
 //!   **Parameters**
 //!
-//!     * `x`,`y` : Values to process. Can be a mix of cayley_dickson and real floating values.
+//!     * `x`,`y` : Values to process. Can be a mix of Cayley_dickson and real floating values.
 //!
 //!   **Return value**
 //!
 //!      \f$\displaystyle  \mathbf{B}(x,y) = \frac{\Gamma(x)\Gamma(y)}{\Gamma(x+y)}\f$ is returned.
 //!     If  `x` and `y` are real typed values they are treated as complex inputs.
 //!
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: Beta Function](https://mathworld.wolfram.com/BetaFunction.html)
+//!
 //!  @groupheader{Example}
 //!
 //!  @godbolt{doc/beta.cpp}

diff --git a/include/kyosu/functions/commutator.hpp b/include/kyosu/functions/commutator.hpp
@@ -56,6 +56,10 @@ namespace kyosu
 //!
 //!     Returns the difference z0*z1-z1*z0.
 //!
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: Commutator](https://mathworld.wolfram.com/Commutator.html)
+//!   *  [Wikipedia: Commutator](https://en.wikipedia.org/wiki/Commutator)
+//!
 //!  @groupheader{Example}
 //!
 //!  @godbolt{doc/commutator.cpp}

diff --git a/include/kyosu/functions/conj.hpp b/include/kyosu/functions/conj.hpp
@@ -58,8 +58,12 @@ namespace kyosu
 //!
 //!     For real inputs the call reduces to identity.
 //!
-//!  @groupheader{Example}
+//!  @groupheader{External references}
+//!   *  [C++ standard reference: complex conj](https://en.cppreference.com/w/cpp/numeric/complex/conj)
+//!   *  [Wolfram MathWorld: complex conjugate](https://mathworld.wolfram.com/ComplexConjugate.html)
+//!   *  [Wikipedia:complex conjugate](https://en.wikipedia.org/wiki/Complex_conjugate)
 //!
+//!  @groupheader{Example}
 //!  @godbolt{doc/conj.cpp}
 //======================================================================================================================
 

diff --git a/include/kyosu/functions/cos.hpp b/include/kyosu/functions/cos.hpp
@@ -67,8 +67,12 @@ namespace kyosu
 //!     3.  Returns \f$\cosh(I_z\; z)\f$ if \f$z\f$ is not zero else \f$\cos(z_0)\f$, where \f$I_z = \frac{\underline{z}}{|\underline{z}|}\f$ and
 //!         \f$\underline{z}\f$ is the [pure](@ref kyosu::imag ) part of \f$z\f$.
 //!
-//!  @groupheader{Example}
+//!  @groupheader{External references}
+//!   *  [C++ standard reference: complex cos](https://en.cppreference.com/w/cpp/numeric/complex/cos)
+//!   *  [Wolfram MathWorld: Cosine](https://mathworld.wolfram.com/Cosine.html)
+//!   *  [Wikipedia: cosinus](https://fr.wikipedia.org/wiki/cosinus)
 //!
+//!  @groupheader{Example}
 //!  @godbolt{doc/cos.cpp}
 //======================================================================================================================
   inline constexpr auto cos = eve::functor<cos_t>;

diff --git a/include/kyosu/functions/cosh.hpp b/include/kyosu/functions/cosh.hpp
@@ -99,6 +99,11 @@ namespace kyosu
 //!
 //!     3. Is semantically equivalent to `(exp(z)+exp(-z))/2`.
 //!
+//!  @groupheader{External references}
+//!   *  [C++ standard reference: complex cosh](https://en.cppreference.com/w/cpp/numeric/complex/cosh)
+//!   *  [Wolfram MathWorld: Hyperbolic Cosine](https://mathworld.wolfram.com/HyperbolicCosine.html)
+//!   *  [Wikipedia: hyperbolic functions](https://en.wikipedia.org/wiki/Hyperbolic_functions)
+//!
 //!  @groupheader{Example}
 //!  @godbolt{doc/cosh.cpp}
 //======================================================================================================================

diff --git a/include/kyosu/functions/cot.hpp b/include/kyosu/functions/cot.hpp
@@ -66,8 +66,10 @@ namespace kyosu
 //!
 //!     Returns the cotangent of the argument.
 //!
-//!  @groupheader{Example}
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: Cotangent](https://mathworld.wolfram.com/Cotangent.html)
 //!
+//!  @groupheader{Example}
 //!  @godbolt{doc/cot.cpp}
 //======================================================================================================================
   inline constexpr auto cot = eve::functor<cot_t>;

diff --git a/include/kyosu/functions/coth.hpp b/include/kyosu/functions/coth.hpp
@@ -65,6 +65,9 @@ namespace kyosu
 //!
 //!     Returns the hyperbolic cotangent of the argument.
 //!
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: Hyperbolic Cotangent](https://mathworld.wolfram.com/HyperbolicCotangent.html)
+//!
 //!  @groupheader{Example}
 //!
 //!  @godbolt{doc/coth.cpp}

diff --git a/include/kyosu/functions/csc.hpp b/include/kyosu/functions/csc.hpp
@@ -57,6 +57,9 @@ namespace kyosu
 //!
 //!     Returns the cosecant of the argument.
 //!
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: Cosecant](https://mathworld.wolfram.com/Cosecant.html)
+//!
 //!  @groupheader{Example}
 //!
 //!  @godbolt{doc/csc.cpp}

diff --git a/include/kyosu/functions/csch.hpp b/include/kyosu/functions/csch.hpp
@@ -57,6 +57,9 @@ namespace kyosu
 //!
 //!     Returns the hyperbolic cosecant of the argument.
 //!
+//!  @groupheader{External references}
+//!   *  [Wolfram MathWorld: Hyperbolic Cosecant](https://mathworld.wolfram.com/HyperbolicCosecant.html)
+//!
 //!  @groupheader{Example}
 //!
 //!  @godbolt{doc/csch.cpp}