Files
ThirdParty-6/ParaView-5.0.1/Utilities/Doxygen/doxyfile.in

190 lines
8.4 KiB
Plaintext

# -------------------------------------------------------------------------
# doxyfile for ParaView
# modified by S. Barre (Time-stamp: <2005-12-05 12:59:07 barre>
# -------------------------------------------------------------------------
PROJECT_NAME = ParaView
FULL_PATH_NAMES = YES
WARN_IF_UNDOCUMENTED = NO
GENERATE_TREEVIEW = NO
GENERATE_TODOLIST = YES
GENERATE_BUGLIST = YES
GENERATE_HTML = YES
GENERATE_HTMLHELP = YES
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
GENERATE_TAGFILE = "@CMAKE_CURRENT_BINARY_DIR@/ParaView.tag"
PDF_HYPERLINKS = YES
HAVE_DOT = @HAVE_DOT_YESNO@
DOT_PATH = "@DOT_PATH@"
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CLASS_DIAGRAMS = YES
GENERATE_LEGEND = YES
GRAPHICAL_HIERARCHY = NO # ends up being too large and useless.
MAX_DOT_GRAPH_DEPTH = 3
ALLEXTERNALS = NO
IMAGE_PATH = "@CMAKE_CURRENT_SOURCE_DIR@/images"
OUTPUT_DIRECTORY = "@CMAKE_CURRENT_BINARY_DIR@/doc"
INPUT = \
"@CMAKE_CURRENT_SOURCE_DIR@/pages" \
"@CMAKE_CURRENT_SOURCE_DIR@/../../CoProcessing/Adaptors/CamAdaptor" \
"@CMAKE_CURRENT_BINARY_DIR@/pages" \
"@CMAKE_CURRENT_BINARY_DIR@/dox" \
"@CMAKE_CURRENT_BINARY_DIR@/dox/doc_ParaView_events2.dox" \
"@CMAKE_CURRENT_BINARY_DIR@/dox/doc_ParaView_events.dox" \
"@CMAKE_CURRENT_BINARY_DIR@/dox/doc_ParaView_index.dox" \
@PV_MODULE_DIRS_DOXYGEN_ESCAPED@
# Since vtk.*.h header files are prepreprocessed using perl and placed under the "dox"
# sub-directory, we don't want them to get processed twice. Hence, we exlcude the original
# vtk* headers from the source dir.
EXCLUDE_PATTERNS = "@ParaView_SOURCE_DIR@/*/vtk*.h"
EXCLUDE = \
"@ParaView_SOURCE_DIR@/Web/Documentation" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/Core/vtkSetGet.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/DataModel/vtkMarchingSquaresCases.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/DataModel/vtkMarchingCubesCases.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/Core/vtkWindows.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkTcl.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkTk.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkTclUtil.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkPython.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkPythonUtil.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkJavaAwt.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkJavaUtil.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkPythonUtil.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Common/vtkTclUtil.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Parallel/MPI/vtkMPI.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/IO/Import/vtk3DS.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/IO/Import/vtkVRML.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/IO/PLY/vtkPLY.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Rendering/OpenGL/vtkOpenGL.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Rendering/FreeType/fonts/vtkEmbeddedFonts.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Testing/Rendering/Testing/vtkRegressionTestImage.h" \
"@VTK_BINARY_DIR@/Utilities/Doxygen/dox/Testing/Core/Testing/vtkTestDriver.h" \
# TAGFILES = "@VTK_BINARY_DIR@/Utilities/Doxygen/vtk@VTK_MAJOR_VERSION@-nightly.tag"=http://www.vtk.org/doc/nightly/html
TAGFILES = @TAGFILES@
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = YES
ALWAYS_DETAILED_SEC = NO
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
CASE_SENSE_NAMES = YES
VERBATIM_HEADERS = NO
SHOW_INCLUDE_FILES = YES
JAVADOC_AUTOBRIEF = YES
SORT_MEMBER_DOCS = NO
DISTRIBUTE_GROUP_DOC = YES
TAB_SIZE = 3
DETAILS_AT_TOP = YES
SHORT_NAMES = @DOXYGEN_SHORT_NAMES@
# PAPER_TYPE = letter
FILE_PATTERNS = *.h *.md
RECURSIVE = YES
HTML_ALIGN_MEMBERS = YES
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 3
IGNORE_PREFIX = vtkPV vtkSM vtk pq vtkCP
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
EXPAND_ONLY_PREDEF = YES
PREDEFINED = "vtkSetMacro(name,type)= \
virtual void Set##name (type);" \
"vtkGetMacro(name,type)= \
virtual type Get##name ();" \
"vtkSetStringMacro(name)= \
virtual void Set##name (const char*);" \
"vtkGetStringMacro(name)= \
virtual char* Get##name ();" \
"vtkSetClampMacro(name,type,min,max)= \
virtual void Set##name (type);" \
"vtkSetObjectMacro(name,type)= \
virtual void Set##name (type*);" \
"vtkGetObjectMacro(name,type)= \
virtual type *Get##name ();" \
"vtkBooleanMacro(name,type)= \
virtual void name##On (); \
virtual void name##Off ();" \
"vtkSetVector2Macro(name,type)= \
virtual void Set##name (type, type); \
void Set##name (type [2]);" \
"vtkGetVector2Macro(name,type)= \
virtual type *Get##name (); \
virtual void Get##name (type &, type &); \
virtual void Get##name (type [2]);" \
"vtkSetVector3Macro(name,type)= \
virtual void Set##name (type, type, type); \
virtual void Set##name (type [3]);" \
"vtkGetVector3Macro(name,type)= \
virtual type *Get##name (); \
virtual void Get##name (type &, type &, type &); \
virtual void Get##name (type [3]);" \
"vtkSetVector4Macro(name,type)= \
virtual void Set##name (type, type, type, type); \
virtual void Set##name (type [4]);" \
"vtkGetVector4Macro(name,type)= \
virtual type *Get##name (); \
virtual void Get##name (type &, type &, type &, type &); \
virtual void Get##name (type [4]);" \
"vtkSetVector6Macro(name,type)= \
virtual void Set##name (type, type, type, type, \
type, type); \
virtual void Set##name (type [6]);" \
"vtkGetVector6Macro(name,type)= \
virtual type *Get##name (); \
virtual void Get##name (type &, type &, type &, \
type &, type &, type &); \
virtual void Get##name (type [6]);" \
"vtkSetVectorMacro(name,type,count)= \
virtual void Set##name(type data[]);" \
"vtkGetVectorMacro(name,type,count)= \
virtual type *Get##name (); \
virtual void Get##name(type data[##count]);" \
"vtkWorldCoordinateMacro(name)= \
virtual vtkCoordinate *Get##name##Coordinate (); \
virtual void Set##name(float x[3]); \
virtual void Set##name(float x, float y, float z); \
virtual float *Get##name();" \
"vtkViewportCoordinateMacro(name)= \
virtual vtkCoordinate *Get##name##Coordinate (); \
virtual void Set##name(float x[2]); \
virtual void Set##name(float x, float y); \
virtual float *Get##name();" \
"vtkTypeMacro(thisClass,superclass)= \
typedef superclass Superclass; \
virtual const char *GetClassName(); \
static int IsTypeOf(const char *type); \
virtual int IsA(const char *type); \
static thisClass* SafeDownCast(vtkObject *o);" \
"vtkTypeMacro(thisClass,superclass)= \
typedef superclass Superclass; \
virtual const char *GetClassName(); \
static int IsTypeOf(const char *type); \
virtual int IsA(const char *type); \
static thisClass* SafeDownCast(vtkObject *o);" \
"VTK_LEGACY(x)= x"