Shuenhoy/vtk-m
1
0
Fork 0
mirror of https://gitlab.kitware.com/vtk/vtk-m synced 2024-09-16 17:22:55 +00:00
Code Issues 2 Actions Packages Projects Releases Wiki Activity

First initial pass at cleaning up the doxygen generation for vtkm

Browse Source
This commit is contained in:
Robert Maynard 2017-07-05 17:45:05 -04:00
parent 41fbff9064
commit ccc8455e1d
4 changed files with 24 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CMake/VTKmBuildDocumentation.cmake
View File

@ -29,9 +29,7 @@ find_package(Doxygen REQUIRED)
set(VTKm_DOXYGEN_HAVE_DOT ${DOXYGEN_DOT_FOUND})
set(VTKm_DOXYGEN_DOT_PATH ${DOXYGEN_DOT_PATH})
set(VTKm_DOXYFILE ${CMAKE_CURRENT_BINARY_DIR}/docs/doxyfile)
set(VTKm_DOXYGEN_EXCLUDE_FILES
${VTKm_SOURCE_DIR}/vtkm/testing/OptionParser.h
)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/CMake/doxyfile.in ${VTKm_DOXYFILE}
@ONLY)

21
CMake/doxyfile.in
View File

@ -46,6 +46,8 @@ STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
SHOW_NAMESPACES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
@ -142,11 +144,18 @@ FILE_PATTERNS = *.cxx *.h *.cu
RECURSIVE = YES
EXCLUDE = @VTKm_DOXYGEN_EXCLUDE_FILES@
EXCLUDE = @VTKm_SOURCE_DIR@/vtkm/testing/OptionParser.h
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_PATTERNS = */testing/*
EXCLUDE_PATTERNS += */examples/*
EXCLUDE_PATTERNS += UnitTest*
EXCLUDE_SYMBOLS = thrust
EXCLUDE_SYMBOLS += detail
EXCLUDE_SYMBOLS += placeholders
EXCLUDE_SYMBOLS += benchmarking
EXAMPLE_PATH =
@ -182,7 +191,7 @@ VERBATIM_HEADERS = YES
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
@ -364,11 +373,11 @@ COLLABORATION_GRAPH = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDE_GRAPH = NO
INCLUDED_BY_GRAPH = YES
INCLUDED_BY_GRAPH = NO
CALL_GRAPH = NO

2
vtkm/Types.h
View File

@ -350,7 +350,7 @@ template <typename T, vtkm::IdComponent Size>
class VTKM_ALWAYS_EXPORT Vec;
template <typename T>
class VTKM_ALWAYS_EXPORTVecC;
class VTKM_ALWAYS_EXPORT VecC;
template <typename T>
class VTKM_ALWAYS_EXPORT VecCConst;

10
vtkm/internal/IntegerSequence.h
View File

@ -41,9 +41,11 @@ struct IntegerSequence
namespace detail
{
template <int N, int... Is> //unroll in blocks of 4
struct MakeSeq : MakeSeq<N - 4, N - 3, N - 2, N - 1, N, Is...>
template <int N, int... Is> //unroll in blocks of 4
struct MakeSeq /** @cond */ : MakeSeq<N - 4, N - 3, N - 2, N - 1, N, Is...> /** @endcond */
{
//The cond/endcond are used to tell doxygen to ignore the inheritance, as that
//builds a massive inheritance tree
};
template <int... Is>
@ -106,8 +108,10 @@ struct PreMakeSeq<0, -1>
/// \brief A helper method to create an Integer sequence of 0...N-1.
template <int N>
struct MakeIntegerSequence : detail::PreMakeSeq<N % 4, N - 1>
struct MakeIntegerSequence /** @cond */ : detail::PreMakeSeq<N % 4, N - 1> /** @endcond */
{
//The cond/endcond are used to tell doxygen to ignore the inheritance, as that
//builds a massive inheritance tree
};
}
}