Merge topic 'doxygen_fixes'

1e53b86ea Identifiers in doxygen @param blocks must appear in signature.
828bb3179 Silence expected doxygen warning.
6db40ae49 Newline needed after \file command.

Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Robert Maynard <robert.maynard@kitware.com>
Merge-request: !1291
This commit is contained in:
Allison Vacanti 2018-06-28 15:35:38 +00:00 committed by Kitware Robot
commit 404939d6d4
3 changed files with 12 additions and 4 deletions

@ -28,6 +28,9 @@ list(APPEND CTEST_CUSTOM_WARNING_EXCEPTION
# disable doxygen warning about not generating graph
".*warning: Included by graph for"
# Doxygen warns when creating output directory:
"Notice: Output directory.*does not exist. I have created it for you."
# disable doxygen warnings from CONTRIBUTING.md, CodingConventions.md.
# these files are really intended for Gitlab, hence we don't want to use
# doxygen tags in them.

@ -173,9 +173,10 @@ public:
/// \param coords An ArrayHandle of x, y, z coordinates of input points.
/// \param device Tag for selecting device adapter
template <typename DeviceAdapter>
void Build(const vtkm::cont::ArrayHandle<vtkm::Vec<T, 3>>& coords,
DeviceAdapter vtkmNotUsed(device))
void Build(const vtkm::cont::ArrayHandle<vtkm::Vec<T, 3>>& coords, DeviceAdapter device)
{
(void)device;
using Algorithm = vtkm::cont::DeviceAdapterAlgorithm<DeviceAdapter>;
// generate unique id for each input point
vtkm::cont::ArrayHandleCounting<vtkm::Id> pointCounting(0, 1, coords.GetNumberOfValues());
@ -213,8 +214,10 @@ public:
const vtkm::cont::ArrayHandle<vtkm::Vec<T, 3>>& queryPoints,
vtkm::cont::ArrayHandle<vtkm::Id>& nearestNeighborIds,
vtkm::cont::ArrayHandle<T>& distances,
DeviceAdapter)
DeviceAdapter device)
{
(void)device;
UniformGridSearch uniformGridSearch(Min, Max, Dims);
vtkm::worklet::DispatcherMapField<UniformGridSearch, DeviceAdapter> searchDispatcher(

@ -19,7 +19,9 @@
//============================================================================
#ifndef vtk_m_exec_CellMeasure_h
#define vtk_m_exec_CellMeasure_h
/*!\file Functions that provide integral measures over cells. */
/*!\file
* Functions that provide integral measures over cells.
*/
#include "vtkm/CellShape.h"
#include "vtkm/CellTraits.h"