mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
Update vtk-m doxygen to generate less warnings
This commit is contained in:
parent
97a2408fc4
commit
a652f7fe1e
@ -357,8 +357,6 @@ ALLEXTERNALS = NO
|
||||
|
||||
EXTERNAL_GROUPS = YES
|
||||
|
||||
PERL_PATH = /usr/bin/perl
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the dot tool
|
||||
#---------------------------------------------------------------------------
|
||||
|
@ -10,10 +10,16 @@
|
||||
|
||||
list(APPEND CTEST_CUSTOM_WARNING_EXCEPTION
|
||||
".*warning: ignoring loop annotation.*"
|
||||
".*warning: Included by graph for.*not generated, too many nodes. Consider increasing DOT_GRAPH_MAX_NODES."
|
||||
".*warning: Included by graph for.*not generated, too many nodes. Consider increasing DOT_GRAPH_MAX_NODES.*"
|
||||
|
||||
# disable doxygen warnings about no matching members caused by auto keyword
|
||||
".*warning: no matching file member found for.*"
|
||||
|
||||
# disable doxygen warning from VTKM_DEPRECATED usage
|
||||
".*warning: Found.*while parsing initializer list!.*"
|
||||
|
||||
# disable doxygen warning about potential recursion.
|
||||
".*warning: Detected potential recursive class relation between class vtkm::exec::internal::ArrayPortalTransform"
|
||||
".*warning: Detected potential recursive class relation between .*"
|
||||
|
||||
# disable doxygen warning about not generating graph
|
||||
".*warning: Included by graph for"
|
||||
|
@ -131,6 +131,7 @@ VTKM_EXEC_CONT auto make_tuple(Ts&&... args) -> decltype(vtkm::MakeTuple(std::fo
|
||||
return vtkm::MakeTuple(std::forward<Ts>(args)...);
|
||||
}
|
||||
|
||||
/// @cond NONE
|
||||
namespace detail
|
||||
{
|
||||
struct TupleTransformFunctor
|
||||
@ -171,6 +172,7 @@ VTKM_EXEC_CONT auto TupleForEach(TupleType&& tuple, Function&& f)
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
/// @endcond
|
||||
|
||||
template <>
|
||||
class Tuple<>
|
||||
|
@ -123,8 +123,8 @@ struct VTKM_NEVER_EXPORT VecTraits
|
||||
/// \brief Get a vector of the same type but with a different component.
|
||||
///
|
||||
/// This type resolves to another vector with a different component type. For example,
|
||||
/// vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2>
|
||||
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
||||
/// is vtkm::Vec<T2, N>.
|
||||
///
|
||||
template <typename NewComponentType>
|
||||
@ -134,7 +134,7 @@ struct VTKM_NEVER_EXPORT VecTraits
|
||||
///
|
||||
/// This type resolves to another vector with a different base component type. The replacement
|
||||
/// is recursive for nested types. For example,
|
||||
/// VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> is Vec<Vec<T2, M>, N>.
|
||||
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
||||
///
|
||||
template <typename NewComponentType>
|
||||
using ReplaceBaseComponentType = VecTemplate<
|
||||
@ -270,8 +270,8 @@ struct VTKM_NEVER_EXPORT VecTraits<vtkm::Vec<T, Size>>
|
||||
/// \brief Get a vector of the same type but with a different component.
|
||||
///
|
||||
/// This type resolves to another vector with a different component type. For example,
|
||||
/// vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2>
|
||||
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
||||
/// is vtkm::Vec<T2, N>.
|
||||
///@{
|
||||
#if defined(VTKM_GCC) && (__GNUC__ <= 5)
|
||||
@ -289,7 +289,7 @@ struct VTKM_NEVER_EXPORT VecTraits<vtkm::Vec<T, Size>>
|
||||
///
|
||||
/// This type resolves to another vector with a different base component type. The replacement
|
||||
/// is recursive for nested types. For example,
|
||||
/// VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> is Vec<Vec<T2, M>, N>.
|
||||
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
||||
///@{
|
||||
#if defined(VTKM_GCC) && (__GNUC__ <= 5)
|
||||
// Silly workaround for bug in GCC <= 5
|
||||
@ -381,8 +381,8 @@ struct VTKM_NEVER_EXPORT VecTraits<vtkm::VecC<T>>
|
||||
/// \brief Get a vector of the same type but with a different component.
|
||||
///
|
||||
/// This type resolves to another vector with a different component type. For example,
|
||||
/// vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2>
|
||||
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
||||
/// is vtkm::Vec<T2, N>.
|
||||
///
|
||||
template <typename NewComponentType>
|
||||
@ -392,7 +392,7 @@ struct VTKM_NEVER_EXPORT VecTraits<vtkm::VecC<T>>
|
||||
///
|
||||
/// This type resolves to another vector with a different base component type. The replacement
|
||||
/// is recursive for nested types. For example,
|
||||
/// VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> is Vec<Vec<T2, M>, N>.
|
||||
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
||||
///
|
||||
template <typename NewComponentType>
|
||||
using ReplaceBaseComponentType = vtkm::VecC<
|
||||
@ -470,8 +470,8 @@ struct VTKM_NEVER_EXPORT VecTraits<vtkm::VecCConst<T>>
|
||||
/// \brief Get a vector of the same type but with a different component.
|
||||
///
|
||||
/// This type resolves to another vector with a different component type. For example,
|
||||
/// vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2>
|
||||
/// @code vtkm::VecTraits<vtkm::Vec<T, N>>::ReplaceComponentType<T2> @endcode is vtkm::Vec<T2, N>.
|
||||
/// This replacement is not recursive. So @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode
|
||||
/// is vtkm::Vec<T2, N>.
|
||||
///
|
||||
template <typename NewComponentType>
|
||||
@ -481,7 +481,7 @@ struct VTKM_NEVER_EXPORT VecTraits<vtkm::VecCConst<T>>
|
||||
///
|
||||
/// This type resolves to another vector with a different base component type. The replacement
|
||||
/// is recursive for nested types. For example,
|
||||
/// VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> is Vec<Vec<T2, M>, N>.
|
||||
/// @code VecTraits<Vec<Vec<T, M>, N>::ReplaceComponentType<T2> @endcode is Vec<Vec<T2, M>, N>.
|
||||
///
|
||||
template <typename NewComponentType>
|
||||
using ReplaceBaseComponentType = vtkm::VecCConst<
|
||||
|
@ -23,7 +23,7 @@ namespace vtkm
|
||||
{
|
||||
namespace cont
|
||||
{
|
||||
|
||||
/// @cond NONE
|
||||
namespace detail
|
||||
{
|
||||
template <typename Device, typename T>
|
||||
@ -365,6 +365,7 @@ struct UpperBoundsFunctor
|
||||
}
|
||||
};
|
||||
} // namespace detail
|
||||
/// @endcond
|
||||
|
||||
struct Algorithm
|
||||
{
|
||||
|
@ -83,7 +83,6 @@ using IsInValidArrayHandle =
|
||||
template <typename ArrayHandle>
|
||||
using IsWritableArrayHandle =
|
||||
vtkm::internal::PortalSupportsSets<typename std::decay<ArrayHandle>::type::WritePortalType>;
|
||||
/// @}
|
||||
|
||||
/// Checks to see if the given object is an array handle. This check is
|
||||
/// compatible with C++11 type_traits. It a typedef named \c type that is
|
||||
|
@ -175,7 +175,7 @@
|
||||
/// \def VTKM_LOG_CAST_FAIL(inObj, outType)
|
||||
/// \brief Convenience macro for logging a failed cast of dynamic object.
|
||||
/// \param inObj The dynamic object.
|
||||
/// \param outObj The candidate type (or typelist) that was unsuccessful.
|
||||
/// \param outType The candidate type (or typelist) that was unsuccessful.
|
||||
|
||||
/// \def VTKM_LOG_TRYEXECUTE_FAIL(errorMessage, functorName, deviceId)
|
||||
/// \brief Convenience macro for logging a TryExecute failure to the Error level.
|
||||
|
@ -290,9 +290,10 @@ struct VTKM_ALWAYS_EXPORT ArrayPortalExtrude
|
||||
vtkm::Int32 NumberOfPlanes;
|
||||
bool UseCylindrical;
|
||||
};
|
||||
|
||||
template <typename PortalType>
|
||||
typename ArrayPortalExtrude<PortalType>::ValueType
|
||||
ArrayPortalExtrude<PortalType>::ArrayPortalExtrude::Get(vtkm::Id index) const
|
||||
typename ArrayPortalExtrude<PortalType>::ValueType ArrayPortalExtrude<PortalType>::Get(
|
||||
vtkm::Id index) const
|
||||
{
|
||||
using CompType = typename ValueType::ComponentType;
|
||||
|
||||
@ -313,8 +314,8 @@ ArrayPortalExtrude<PortalType>::ArrayPortalExtrude::Get(vtkm::Id index) const
|
||||
}
|
||||
|
||||
template <typename PortalType>
|
||||
typename ArrayPortalExtrude<PortalType>::ValueType
|
||||
ArrayPortalExtrude<PortalType>::ArrayPortalExtrude::Get(vtkm::Id2 index) const
|
||||
typename ArrayPortalExtrude<PortalType>::ValueType ArrayPortalExtrude<PortalType>::Get(
|
||||
vtkm::Id2 index) const
|
||||
{
|
||||
using CompType = typename ValueType::ComponentType;
|
||||
|
||||
@ -336,7 +337,7 @@ ArrayPortalExtrude<PortalType>::ArrayPortalExtrude::Get(vtkm::Id2 index) const
|
||||
|
||||
template <typename PortalType>
|
||||
vtkm::Vec<typename ArrayPortalExtrude<PortalType>::ValueType, 6>
|
||||
ArrayPortalExtrude<PortalType>::ArrayPortalExtrude::GetWedge(const IndicesExtrude& index) const
|
||||
ArrayPortalExtrude<PortalType>::GetWedge(const IndicesExtrude& index) const
|
||||
{
|
||||
using CompType = typename ValueType::ComponentType;
|
||||
|
||||
|
@ -41,6 +41,7 @@ struct FetchTagArrayTopologyMapIn
|
||||
{
|
||||
};
|
||||
|
||||
/// @cond NONE
|
||||
namespace detail
|
||||
{
|
||||
|
||||
@ -188,6 +189,7 @@ struct FetchArrayTopologyMapInImplementation<
|
||||
};
|
||||
|
||||
} // namespace detail
|
||||
/// @endcond
|
||||
|
||||
template <typename ExecObjectType>
|
||||
struct Fetch<vtkm::exec::arg::FetchTagArrayTopologyMapIn,
|
||||
|
@ -197,7 +197,7 @@ struct GetRowsColsSlices
|
||||
/// Get the number of rows, cols, and slices of a vtkm::cont::CellSetStructured
|
||||
/// @param[in] cells The input vtkm::cont::CellSetStructured
|
||||
/// @param[out] nRows Number of rows (x) in the cell set
|
||||
/// @param[out[ nCols Number of columns (y) in the cell set
|
||||
/// @param[out] nCols Number of columns (y) in the cell set
|
||||
/// @param[out] nSlices Number of slices (z) in the cell set
|
||||
void operator()(const vtkm::cont::CellSetStructured<2>& cells,
|
||||
vtkm::Id& nRows,
|
||||
|
@ -51,7 +51,7 @@ public:
|
||||
/// \param nearestNeighborIds Nearest neighbor in the traning data set for each points in the
|
||||
/// testing set
|
||||
/// \param distances Distances between query points and their nearest neighbors.
|
||||
/// \param device Tag for selecting device adapter.
|
||||
/// \param deviceId Tag for selecting device adapter.
|
||||
template <typename CoordType,
|
||||
typename CoordStorageTag1,
|
||||
typename CoordStorageTag2,
|
||||
|
Loading…
Reference in New Issue
Block a user