Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-10-05 01:49:02 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

Fix doxygen warnings with worklet base classes

Browse Source 
Some versions of doxygen have issues with documenting `typedef`s (or the
equivalent `using`). This was causing warnings with doxygen and failing
to create some of the documentation. This fixes the problem by moving the
documentation to the classes things are defined to.
This commit is contained in:
Kenneth Moreland 2024-02-12 15:18:09 +09:00
parent 27ee972371
commit 46508487a0
12 changed files with 95 additions and 109 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
vtkm/exec/arg/InputIndex.h
View File

@ -20,9 +20,9 @@ namespace exec
namespace arg
{
/// \brief Aspect tag to use for getting the work index.
/// @brief Aspect tag to use for getting the work index.
///
/// The \c AspectTagInputIndex aspect tag causes the \c Fetch class to ignore
/// The `AspectTagInputIndex` aspect tag causes the \c Fetch class to ignore
/// whatever data is in the associated execution object and return the index
/// of the input element.
///
@ -30,15 +30,16 @@ struct AspectTagInputIndex
{
};
/// \brief The \c ExecutionSignature tag to use to get the input index
/// @brief The `ExecutionSignature` tag to use to get the input index
///
/// This tag produces a `vtkm::Id` that identifies the index of the input
/// element, which can differ from the `WorkIndex` in a worklet with a scatter.
///
/// When a worklet is dispatched, it broken into pieces defined by the input
/// domain and scheduled on independent threads. This tag in the \c
/// ExecutionSignature passes the index of the input element that the work
/// domain and scheduled on independent threads. This tag in the
/// `ExecutionSignature` passes the index of the input element that the work
/// thread is currently working on. When a worklet has a scatter associated
/// with it, the input and output indices can be different. \c WorkletBase
/// contains a typedef that points to this class.
///
/// with it, the input and output indices can be different.
struct InputIndex : vtkm::exec::arg::ExecutionSignatureTagBase
{
// The index does not really matter because the fetch is going to ignore it.

16
vtkm/exec/arg/OutputIndex.h
View File

@ -20,9 +20,9 @@ namespace exec
namespace arg
{
/// \brief Aspect tag to use for getting the work index.
/// @brief Aspect tag to use for getting the work index.
///
/// The \c AspectTagOutputIndex aspect tag causes the \c Fetch class to ignore
/// The `AspectTagOutputIndex` aspect tag causes the `Fetch` class to ignore
/// whatever data is in the associated execution object and return the index
/// of the output element.
///
@ -30,14 +30,16 @@ struct AspectTagOutputIndex
{
};
/// \brief The \c ExecutionSignature tag to use to get the output index
/// @brief The `ExecutionSignature` tag to use to get the output index
///
/// This tag produces a `vtkm::Id` that identifies the index of the output element.
/// (This is generally the same as `WorkIndex`.)
///
/// When a worklet is dispatched, it broken into pieces defined by the output
/// domain and scheduled on independent threads. This tag in the \c
/// ExecutionSignature passes the index of the output element that the work
/// domain and scheduled on independent threads. This tag in the
/// `ExecutionSignature` passes the index of the output element that the work
/// thread is currently working on. When a worklet has a scatter associated
/// with it, the output and output indices can be different. \c WorkletBase
/// contains a typedef that points to this class.
/// with it, the output and output indices can be different.
///
struct OutputIndex : vtkm::exec::arg::ExecutionSignatureTagBase
{

13
vtkm/exec/arg/ThreadIndices.h
View File

@ -20,9 +20,9 @@ namespace exec
namespace arg
{
/// \brief Aspect tag to use for getting the thread indices.
/// @brief Aspect tag to use for getting the thread indices.
///
/// The \c AspectTagThreadIndices aspect tag causes the \c Fetch class to
/// The `AspectTagThreadIndices` aspect tag causes the `Fetch` class to
/// ignore whatever data is in the associated execution object and return the
/// thread indices.
///
@ -30,13 +30,16 @@ struct AspectTagThreadIndices
{
};
/// \brief The \c ExecutionSignature tag to use to get the thread indices
/// @brief The `ExecutionSignature` tag to use to get the thread indices
///
/// This tag produces an internal object that manages indices and other metadata
/// of the current thread. Thread indices objects vary by worklet type, but most
/// users can get the information they need through other signature tags.
///
/// When a worklet is dispatched, it broken into pieces defined by the input
/// domain and scheduled on independent threads. During this process multiple
/// indices associated with the input and output can be generated. This tag in
/// the \c ExecutionSignature passes the index for this work. \c WorkletBase
/// contains a typedef that points to this class.
/// the `ExecutionSignature` passes the index for this work.
///
struct ThreadIndices : vtkm::exec::arg::ExecutionSignatureTagBase
{

15
vtkm/exec/arg/VisitIndex.h
View File

@ -20,9 +20,9 @@ namespace exec
namespace arg
{
/// \brief Aspect tag to use for getting the work index.
/// @brief Aspect tag to use for getting the work index.
///
/// The \c AspectTagVisitIndex aspect tag causes the \c Fetch class to ignore
/// The `AspectTagVisitIndex` aspect tag causes the `Fetch` class to ignore
/// whatever data is in the associated execution object and return the visit
/// index.
///
@ -30,15 +30,18 @@ struct AspectTagVisitIndex
{
};
/// \brief The \c ExecutionSignature tag to use to get the visit index
/// @brief The `ExecutionSignature` tag to use to get the visit index
///
/// This tag produces a `vtkm::IdComponent` that uniquely identifies when multiple
/// worklet invocations operate on the same input item, which can happen when
/// defining a worklet with scatter.
///
/// When a worklet is dispatched, there is a scatter operation defined that
/// optionally allows each input to go to multiple output entries. When one
/// input is assigned to multiple outputs, there needs to be a mechanism to
/// uniquely identify which output is which. The visit index is a value between
/// 0 and the number of outputs a particular input goes to. This tag in the \c
/// ExecutionSignature passes the visit index for this work. \c WorkletBase
/// contains a typedef that points to this class.
/// 0 and the number of outputs a particular input goes to. This tag in the
/// `ExecutionSignature` passes the visit index for this work.
///
struct VisitIndex : vtkm::exec::arg::ExecutionSignatureTagBase
{

14
vtkm/exec/arg/WorkIndex.h
View File

@ -20,22 +20,22 @@ namespace exec
namespace arg
{
/// \brief Aspect tag to use for getting the work index.
/// @brief Aspect tag to use for getting the work index.
///
/// The \c AspectTagWorkIndex aspect tag causes the \c Fetch class to ignore
/// The `AspectTagWorkIndex` aspect tag causes the `Fetch` class to ignore
/// whatever data is in the associated execution object and return the index.
///
struct AspectTagWorkIndex
{
};
/// \brief The \c ExecutionSignature tag to use to get the work index
/// @brief The `ExecutionSignature` tag to use to get the work index
///
/// This tag produces a `vtkm::Id` that uniquely identifies the invocation
/// instance of the worklet.
/// When a worklet is dispatched, it broken into pieces defined by the input
/// domain and scheduled on independent threads. This tag in the \c
/// ExecutionSignature passes the index for this work. \c WorkletBase contains
/// a typedef that points to this class.
///
/// domain and scheduled on independent threads. This tag in the
/// `ExecutionSignature` passes the index for this work.
struct WorkIndex : vtkm::exec::arg::ExecutionSignatureTagBase
{
// The index does not really matter because the fetch is going to ignore it.

40
vtkm/worklet/Keys.h
View File

@ -52,27 +52,12 @@ public:
KeysBase& operator=(const KeysBase&) = default;
~KeysBase() = default;
/// @brief Returns the input range of a keys object when used as an input domain.
///
/// This will be equal to the number of unique keys.
VTKM_CONT
vtkm::Id GetInputRange() const { return this->Offsets.GetNumberOfValues() - 1; }
/// @brief Returns the array that maps each input value to an array of sorted keys.
///
/// This array is used internally as the indices to a `vtkm::cont::ArrayHandlePermutation`
/// to order input values with the grouped keys so that they can then be grouped. This is
/// an internal array that is seldom of use to code outside the
/// `vtkm::worklet::WorkletReduceByKey` implementation.
VTKM_CONT
vtkm::cont::ArrayHandle<vtkm::Id> GetSortedValuesMap() const { return this->SortedValuesMap; }
/// @brief Returns an offsets array to group keys.
///
/// Given an array of sorted keys (or more frequently values permuted to the sorting of
/// the keys), this array of indices can be used as offsets for a
/// `vtkm::cont::ArrayHandleGroupVecVariable`. This is an internal array that is seldom of
/// use to code outside the `vtkm::worklet::WorkletReduceByKey` implementation.
VTKM_CONT
vtkm::cont::ArrayHandle<vtkm::Id> GetOffsets() const { return this->Offsets; }
@ -80,9 +65,6 @@ public:
VTKM_CONT
vtkm::cont::ArrayHandle<vtkm::IdComponent> GetCounts() const;
/// @brief Returns the number of input keys and values used to build this structure.
///
/// This is also the size of input arrays to a `vtkm::worklet::WorkletReduceByKey`.
VTKM_CONT
vtkm::Id GetNumberOfValues() const { return this->SortedValuesMap.GetNumberOfValues(); }
@ -196,16 +178,30 @@ public:
#ifdef VTKM_DOXYGEN_ONLY
// Document the superclass' methods as methods in this class.
/// @copydoc vtkm::worklet::internal::KeysBase::GetInputRange
/// @brief Returns the input range of a keys object when used as an input domain.
///
/// This will be equal to the number of unique keys.
vtkm::Id GetInputRange() const;
/// @copydoc vtkm::worklet::internal::KeysBase::GetSortedValuesMap
/// @brief Returns the array that maps each input value to an array of sorted keys.
///
/// This array is used internally as the indices to a `vtkm::cont::ArrayHandlePermutation`
/// to order input values with the grouped keys so that they can then be grouped. This is
/// an internal array that is seldom of use to code outside the
/// `vtkm::worklet::WorkletReduceByKey` implementation.
vtkm::cont::ArrayHandle<vtkm::Id> GetSortedValuesMap() const;
/// @copydoc vtkm::worklet::internal::KeysBase::GetOffsets
/// @brief Returns an offsets array to group keys.
///
/// Given an array of sorted keys (or more frequently values permuted to the sorting of
/// the keys), this array of indices can be used as offsets for a
/// `vtkm::cont::ArrayHandleGroupVecVariable`. This is an internal array that is seldom of
/// use to code outside the `vtkm::worklet::WorkletReduceByKey` implementation.
vtkm::cont::ArrayHandle<vtkm::Id> GetOffsets() const;
/// @copydoc vtkm::worklet::internal::KeysBase::GetNumberOfValues
/// @brief Returns the number of input keys and values used to build this structure.
///
/// This is also the size of input arrays to a `vtkm::worklet::WorkletReduceByKey`.
vtkm::Id GetNumberOfValues() const;
#endif

10
vtkm/worklet/WorkletCellNeighborhood.h
View File

@ -120,27 +120,27 @@ public:
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
/// @copydoc vtkm::exec::arg::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
/// @copydoc vtkm::exec::arg::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
/// @copydoc vtkm::exec::arg::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
/// @copydoc vtkm::exec::arg::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
/// @copydoc vtkm::exec::arg::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};

10
vtkm/worklet/WorkletMapField.h
View File

@ -153,27 +153,27 @@ public:
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
/// @copydoc vtkm::exec::arg::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
/// @copydoc vtkm::exec::arg::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
/// @copydoc vtkm::exec::arg::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
/// @copydoc vtkm::exec::arg::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
/// @copydoc vtkm::exec::arg::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};

20
vtkm/worklet/WorkletMapTopology.h
View File

@ -419,27 +419,27 @@ public:
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
/// @copydoc vtkm::exec::arg::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
/// @copydoc vtkm::exec::arg::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
/// @copydoc vtkm::exec::arg::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
/// @copydoc vtkm::exec::arg::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
/// @copydoc vtkm::exec::arg::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};
@ -612,27 +612,27 @@ public:
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
/// @copydoc vtkm::exec::arg::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
/// @copydoc vtkm::exec::arg::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
/// @copydoc vtkm::exec::arg::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
/// @copydoc vtkm::exec::arg::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
/// @copydoc vtkm::exec::arg::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};

10
vtkm/worklet/WorkletPointNeighborhood.h
View File

@ -116,27 +116,27 @@ public:
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
/// @copydoc vtkm::exec::arg::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
/// @copydoc vtkm::exec::arg::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
/// @copydoc vtkm::exec::arg::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
/// @copydoc vtkm::exec::arg::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
/// @copydoc vtkm::exec::arg::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};

10
vtkm/worklet/WorkletReduceByKey.h
View File

@ -253,27 +253,27 @@ public:
#ifdef VTKM_DOXYGEN_ONLY
// These redeclarations of superclass features are for documentation purposes only.
/// @copydoc vtkm::worklet::internal::WorkletBase::WorkIndex
/// @copydoc vtkm::exec::arg::WorkIndex
struct WorkIndex : vtkm::worklet::internal::WorkletBase::WorkIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::VisitIndex
/// @copydoc vtkm::exec::arg::VisitIndex
struct VisitIndex : vtkm::worklet::internal::WorkletBase::VisitIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::InputIndex
/// @copydoc vtkm::exec::arg::InputIndex
struct InputIndex : vtkm::worklet::internal::WorkletBase::InputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::OutputIndex
/// @copydoc vtkm::exec::arg::OutputIndex
struct OutputIndex : vtkm::worklet::internal::WorkletBase::OutputIndex
{
};
/// @copydoc vtkm::worklet::internal::WorkletBase::ThreadIndices
/// @copydoc vtkm::exec::arg::ThreadIndices
struct ThreadIndices : vtkm::worklet::internal::WorkletBase::ThreadIndices
{
};

29
vtkm/worklet/internal/WorkletBase.h
View File

@ -79,38 +79,19 @@ public:
using _19 = vtkm::placeholders::Arg<19>;
using _20 = vtkm::placeholders::Arg<20>;
/// @brief `ExecutionSignature` tag for getting the work index.
///
/// This tag produces a `vtkm::Id` that uniquely identifies the invocation
/// instance of the worklet.
///
/// @copydoc vtkm::exec::arg::WorkIndex
using WorkIndex = vtkm::exec::arg::WorkIndex;
/// @brief `ExecutionSignature` tag for getting the input index.
///
/// This tag produces a `vtkm::Id` that identifies the index of the input
/// element, which can differ from the `WorkIndex` in a worklet with a scatter.
/// @copydoc vtkm::exec::arg::InputIndex
using InputIndex = vtkm::exec::arg::InputIndex;
/// @brief `ExecutionSignature` tag for getting the output index.
///
/// This tag produces a `vtkm::Id` that identifies the index of the output element.
/// (This is generally the same as `WorkIndex`.)
/// @copydoc vtkm::exec::arg::OutputIndex
using OutputIndex = vtkm::exec::arg::OutputIndex;
/// @brief `ExecutionSignature` tag for getting the thread indices.
///
/// This tag produces an internal object that manages indices and other metadata
/// of the current thread. Thread indices objects vary by worklet type, but most
/// users can get the information they need through other signature tags.
/// @copydoc vtkm::exec::arg::ThreadIndices
using ThreadIndices = vtkm::exec::arg::ThreadIndices;
/// @brief `ExecutionSignature` tag for getting the visit index.
///
/// This tag produces a `vtkm::IdComponent` that uniquely identifies when multiple
/// worklet invocations operate on the same input item, which can happen when
/// defining a worklet with scatter.
///
/// @copydoc vtkm::exec::arg::VisitIndex
using VisitIndex = vtkm::exec::arg::VisitIndex;
/// @brief `ExecutionSignature` tag for getting the device adapter tag.