Skip to content

Commit

Permalink
Fix Documentation generation
Browse files Browse the repository at this point in the history
Mostly ill-named groups, missing predefined macro and some group
splitting for select operation.

Fix #1029
  • Loading branch information
serge-sans-paille committed Oct 5, 2024
1 parent 50a69bf commit ca36a08
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ WARN_AS_ERROR = NO
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = XSIMD_NO_DISCARD=
PREDEFINED = XSIMD_NO_DISCARD= XSIMD_INLINE=inline
6 changes: 2 additions & 4 deletions docs/source/api/batch_manip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,9 @@ Conditional expression

----

.. doxygenfunction:: select(batch_bool<T, A> const &cond, batch<T, A> const &true_br, batch<T, A> const &false_br) noexcept
:project: xsimd

.. doxygenfunction:: select(batch_bool_constant<T, A, Values...> const &cond, batch<T, A> const &true_br, batch<T, A> const &false_br) noexcept
.. doxygengroup:: batch_cond
:project: xsimd
:content-only:


In the specific case when one needs to conditionnaly increment or decrement a
Expand Down
2 changes: 1 addition & 1 deletion docs/source/api/xsimd_batch_complex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Batch of complex numbers
Operations specific to batches of complex numbers
-------------------------------------------------

.. doxygengroup:: batch_complex_op
.. doxygengroup:: batch_complex
:project: xsimd
:content-only:

Expand Down
13 changes: 7 additions & 6 deletions include/xsimd/types/xsimd_api.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,14 @@ namespace xsimd
*
* @defgroup batch_arithmetic Arithmetic operators
* @defgroup batch_constant Constant batches
* @defgroup batch_cond Conditional operators
* @defgroup batch_data_transfer Memory operators
* @defgroup batch_math Basic math operators
* @defgroup batch_math_extra Extra math operators
* @defgroup batch_fp Floating point manipulation
* @defgroup batch_rounding Rounding operators
* @defgroup batch_conversion Conversion operators
* @defgroup batch_complex_op Complex operators
* @defgroup batch_complex Complex operators
* @defgroup batch_logical Logical operators
* @defgroup batch_bitwise Bitwise operators
* @defgroup batch_reducers Reducers
Expand Down Expand Up @@ -1890,7 +1891,7 @@ namespace xsimd
}

/**
* @ingroup rotate_left
* @ingroup batch_data_transfer
*
* Slide the whole batch to the left by \c n bytes, and reintroduce the
* slided out elements from the right. This is different from
Expand All @@ -1908,7 +1909,7 @@ namespace xsimd
}

/**
* @ingroup rotate_right
* @ingroup batch_data_transfer
*
* Slide the whole batch to the right by \c n bytes, and reintroduce the
* slided out elements from the left. This is different from
Expand Down Expand Up @@ -2021,7 +2022,7 @@ namespace xsimd
}

/**
* @ingroup batch_miscellaneous
* @ingroup batch_cond
*
* Ternary operator for batches: selects values from the batches \c true_br or \c false_br
* depending on the boolean values in the constant batch \c cond. Equivalent to
Expand All @@ -2042,7 +2043,7 @@ namespace xsimd
}

/**
* @ingroup batch_miscellaneous
* @ingroup batch_cond
*
* Ternary operator for batches: selects values from the batches \c true_br or \c false_br
* depending on the boolean values in the constant batch \c cond. Equivalent to
Expand All @@ -2063,7 +2064,7 @@ namespace xsimd
}

/**
* @ingroup batch_miscellaneous
* @ingroup batch_cond
*
* Ternary operator for batches: selects values from the batches \c true_br or \c false_br
* depending on the boolean values in the constant batch \c cond. Equivalent to
Expand Down

0 comments on commit ca36a08

Please sign in to comment.