Merge pull request #408 from JohanMabille/breathe

Fixed documentation of overloads

Author: JohanMabille

docs/environment.yml

@@ -4,4 +4,4 @@ channels:
   - conda-forge
 
 dependencies:
-  - breathe==4.16.0
+  - breathe==4.25.1

docs/source/api/basic_functions.rst

@@ -8,11 +8,11 @@ Basic functions
 ===============
 
 .. _abs-function-reference:
-.. doxygenfunction:: abs(const simd_batch<X>& )
+.. doxygenfunction:: abs(const simd_base<X>& )
    :project: xsimd
 
 .. _fabs-function-reference:
-.. doxygenfunction:: fabs(const simd_batch<X>& )
+.. doxygenfunction:: fabs(const simd_base<X>& )
    :project: xsimd
 
 .. _fmod-function-reference:
@@ -24,42 +24,42 @@ Basic functions
    :project: xsimd
 
 .. _fma-function-reference:
-.. doxygenfunction:: fma(const simd_batch<X>&, const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: fma(const simd_base<X>&, const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _fms-function-reference:
-.. doxygenfunction:: fms(const simd_batch<X>&, const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: fms(const simd_base<X>&, const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _fnma-function-reference:
-.. doxygenfunction:: fnma(const simd_batch<X>&, const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: fnma(const simd_base<X>&, const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _fnms-function-reference:
-.. doxygenfunction:: fnms(const simd_batch<X>&, const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: fnms(const simd_base<X>&, const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _min-function-reference:
-.. doxygenfunction:: min(const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: min(const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _max-function-reference:
-.. doxygenfunction:: max(const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: max(const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _fmin-function-reference:
-.. doxygenfunction:: fmin(const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: fmin(const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _fmax-function-reference:
-.. doxygenfunction:: fmax(const simd_batch<X>&, const simd_batch<X>&)
+.. doxygenfunction:: fmax(const simd_base<X>&, const simd_base<X>&)
    :project: xsimd
 
 .. _fdim-function-reference:
 .. doxygenfunction:: fdim(const batch<T, N>&, const batch<T, N>&)
    :project: xsimd
 
 .. _clip-function-reference:
-.. doxygenfunction:: clip(const batch<T, N>&, const batch<T, N>&, const batch<T, N>&)
+.. doxygenfunction:: clip(const simd_base<B>&, const simd_base<B>&, const simd_base<B>&)
    :project: xsimd
 

docs/source/api/classification_functions.rst

@@ -16,6 +16,6 @@ Classification functions
    :project: xsimd
 
 .. _isnan-func-ref:
-.. doxygenfunction:: isnan(const simd_batch<X>&)
+.. doxygenfunction:: isnan(const simd_base<X>&)
    :project: xsimd
 

docs/source/api/exponential_functions.rst

@@ -16,25 +16,25 @@ Exponential functions
    :project: xsimd
 
 .. _exp10-func-ref:
-.. doxygenfunction:: exp10
+.. doxygenfunction:: exp10(const simd_base<B>&)
    :project: xsimd
 
 .. _expm1-func-ref:
-.. doxygenfunction:: expm1
+.. doxygenfunction:: expm1(const simd_base<B>&)
    :project: xsimd
 
 .. _log-function-reference:
 .. doxygenfunction:: log
    :project: xsimd
 
 .. _log2-function-reference:
-.. doxygenfunction:: log2
+.. doxygenfunction:: log2(const simd_base<B>&)
    :project: xsimd
 
 .. _log10-func-ref:
 .. doxygenfunction:: log10
    :project: xsimd
 
 .. _log1p-func-ref:
-.. doxygenfunction:: log1p
+.. doxygenfunction:: log1p(const simd_base<B>&)
    :project: xsimd

docs/source/api/hyperbolic_functions.rst

@@ -16,7 +16,7 @@ Hyperbolic functions
    :project: xsimd
 
 .. _tanh-function-reference:
-.. doxygenfunction:: tanh(const batch<T, N>&)
+.. doxygenfunction:: tanh(const simd_base<B>&)
    :project: xsimd
 
 .. _asinh-func-ref:

docs/source/api/nearint_operations.rst

@@ -8,26 +8,26 @@ Nearest integer floating point operations
 =========================================
 
 .. _ceil-function-reference:
-.. doxygenfunction:: ceil
+.. doxygenfunction:: ceil(const simd_base<B>&)
    :project: xsimd
 
 .. _floor-func-ref:
-.. doxygenfunction:: floor
+.. doxygenfunction:: floor(const simd_base<B>&)
    :project: xsimd
 
 .. _trunc-func-ref:
-.. doxygenfunction:: trunc
+.. doxygenfunction:: trunc(const simd_base<B>&)
    :project: xsimd
 
 .. _round-func-ref:
-.. doxygenfunction:: round
+.. doxygenfunction:: round(const simd_base<B>&)
    :project: xsimd
 
 .. _nearbyint-func-ref:
-.. doxygenfunction:: nearbyint
+.. doxygenfunction:: nearbyint(const simd_base<B>&)
    :project: xsimd
 
 .. _rint-function-reference:
-.. doxygenfunction:: rint
+.. doxygenfunction:: rint(const simd_base<B>&)
    :project: xsimd
 

docs/source/api/power_functions.rst

@@ -8,11 +8,11 @@ Power functions
 ===============
 
 .. _pow-function-reference:
-.. doxygenfunction:: pow
+.. doxygenfunction:: pow(const simd_base<B>&, const simd_base<B>&)
    :project: xsimd
 
 .. _sqrt-function-reference:
-.. doxygenfunction:: sqrt(const simd_batch<X>&)
+.. doxygenfunction:: sqrt(const simd_base<X>&)
    :project: xsimd
 
 .. _cbrt-function-reference:

docs/source/api/trigonometric_functions.rst

@@ -8,34 +8,34 @@ Trigonometric functions
 =======================
 
 .. _sin-function-reference:
-.. doxygenfunction:: sin(const batch<T, N>&)
+.. doxygenfunction:: sin(const simd_base<B>&)
    :project: xsimd
 
 .. _cos-function-reference:
-.. doxygenfunction:: cos(const batch<T, N>&)
+.. doxygenfunction:: cos(const simd_base<B>&)
    :project: xsimd
 
 .. _sincos-func-ref:
-.. doxygenfunction:: sincos(const batch<T, N>&, batch<T, N>&, batch<T, N>&)
+.. doxygenfunction:: sincos(const simd_base<B>&, batch_type_t<B>&, batch_type_t<B>&)
    :project: xsimd
 
 .. _tan-function-reference:
-.. doxygenfunction:: tan(const batch<T, N>&)
+.. doxygenfunction:: tan(const simd_base<B>&)
    :project: xsimd
 
 .. _asin-function-reference:
-.. doxygenfunction:: asin(const batch<T, N>&)
+.. doxygenfunction:: asin(const simd_base<B>&)
    :project: xsimd
 
 .. _acos-function-reference:
-.. doxygenfunction:: acos(const batch<T, N>&)
+.. doxygenfunction:: acos(const simd_base<B>&)
    :project: xsimd
 
 .. _atan-function-reference:
-.. doxygenfunction:: atan(const batch<T, N>&)
+.. doxygenfunction:: atan(const simd_base<B>&)
    :project: xsimd
 
 .. _atan2-func-ref:
-.. doxygenfunction:: atan2(const batch<T, N>&, const batch<T, N>&)
+.. doxygenfunction:: atan2(const simd_base<B>&, const simd_base<B>&)
    :project: xsimd