Skip to content

Commit

Permalink
First pass at doxygen target. Refs #4360.
Browse files Browse the repository at this point in the history
  • Loading branch information
@peterfpeterson
peterfpeterson committed Dec 22, 2011
1 parent 72f3b90 commit 5657cbf
Show file tree
Hide file tree
Showing 3 changed files with 339 additions and 0 deletions.
1 change: 1 addition & 0 deletions Code/Mantid/Framework/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ endif ()

add_subdirectory (MDAlgorithms)
add_subdirectory (MDEvents)
add_subdirectory (Doxygen)

###########################################################################
# Add a custom target to build all of the Framework
Expand Down
55 changes: 55 additions & 0 deletions Code/Mantid/Framework/Doxygen/CMakeLists.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
if(DOXYGEN_FOUND)
configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Mantid_template.doxyfile
${CMAKE_CURRENT_BINARY_DIR}/Mantid_cmake.doxyfile @ONLY)
add_custom_target( doxygen # ALL?
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Mantid_cmake.doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen" VERBATIM
)
endif(DOXYGEN_FOUND)

##### diff Mantid.doxyfile Mantid.doxyfile_vs
# OUTPUT_DIRECTORY = Doc | OUTPUT_DIRECTORY = ../Doc
# QT_AUTOBRIEF = YES | QT_AUTOBRIEF = NO
# WARN_FORMAT = "$file:$line: $text " | WARN_FORMAT = "$file($line): $text"

##### diff Mantid.doxyfile Mantid.doxyfile_web
# OUTPUT_DIRECTORY = Doc | OUTPUT_DIRECTORY = ../Doc
# STRIP_FROM_PATH = | STRIP_FROM_PATH = /isis/mantid_temp/Code/Mantid
# QT_AUTOBRIEF = YES | QT_AUTOBRIEF = NO
# > DETAILS_AT_TOP = NO
# BUILTIN_STL_SUPPORT = NO | BUILTIN_STL_SUPPORT = YES
# > OPTIMIZE_FOR_FORTRAN = NO
# > OPTIMIZE_OUTPUT_VHDL = NO
# EXTRACT_ALL = NO | EXTRACT_ALL = YES
# > SORT_GROUP_NAMES = NO
# SHOW_DIRECTORIES = NO | SHOW_DIRECTORIES = YES
# ALPHABETICAL_INDEX = NO | ALPHABETICAL_INDEX = YES
# > # If the GENERATE_DOCSET tag is set to YES, additional index files
# > # will be generated that can be used as input for Apple's Xcode 3
# > # integrated development environment, introduced with OSX 10.5 (Leopard).
# > # To create a documentation set, doxygen will generate a Makefile in the
# > # HTML output directory. Running make will produce the docset in that
# > # directory and running "make install" will install the docset in
# > # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find
# > # it at startup.
# > GENERATE_DOCSET = NO
# > # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the
# > # feed. A documentation feed provides an umbrella under which multiple
# > # documentation sets from a single provider (such as a company or product suite)
# > # can be grouped.
# > DOCSET_FEEDNAME = "Doxygen generated docs"
# > # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that
# > # should uniquely identify the documentation set bundle. This should be a
# > # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen
# > # will append .docset to the name.
# > DOCSET_BUNDLE_ID = org.doxygen.Project
# MACRO_EXPANSION = YES | MACRO_EXPANSION = NO
# HAVE_DOT = NO | HAVE_DOT = YES
# COLLABORATION_GRAPH = YES | COLLABORATION_GRAPH = NO
# UML_LOOK = NO | UML_LOOK = YES
# TEMPLATE_RELATIONS = NO | TEMPLATE_RELATIONS = YES
# SEARCHENGINE = NO | SEARCHENGINE = YES

##### diff Mantid.doxyfile Mantid.jenkins.doxyfile
# OUTPUT_DIRECTORY = Doc | OUTPUT_DIRECTORY = Code/Mantid/Framework/Doc
283 changes: 283 additions & 0 deletions Code/Mantid/Framework/Doxygen/Mantid_template.doxyfile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
# Doxyfile 1.5.4

#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = Mantid
PROJECT_NUMBER =
OUTPUT_DIRECTORY = Doc
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
QT_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
TYPEDEF_HIDES_STRUCT = NO
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_DIRECTORIES = NO
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text "
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

INPUT = @CMAKE_CURRENT_SOURCE_DIR@/../Algorithms/inc/MantidAlgorithms \
@CMAKE_CURRENT_SOURCE_DIR@/../Algorithms/src \
@CMAKE_CURRENT_SOURCE_DIR@/../API/inc/MantidAPI \
@CMAKE_CURRENT_SOURCE_DIR@/../API/src \
@CMAKE_CURRENT_SOURCE_DIR@/../Crystal/inc/MantidCrystal \
@CMAKE_CURRENT_SOURCE_DIR@/../Crystal/src \
@CMAKE_CURRENT_SOURCE_DIR@/../CurveFitting/inc/MantidCurveFitting \
@CMAKE_CURRENT_SOURCE_DIR@/../CurveFitting/src \
@CMAKE_CURRENT_SOURCE_DIR@/../DataHandling/inc/MantidDataHandling \
@CMAKE_CURRENT_SOURCE_DIR@/../DataHandling/src \
@CMAKE_CURRENT_SOURCE_DIR@/../DataObjects/inc/MantidDataObjects \
@CMAKE_CURRENT_SOURCE_DIR@/../DataObjects/src \
@CMAKE_CURRENT_SOURCE_DIR@/../Geometry/inc/MantidGeometry \
@CMAKE_CURRENT_SOURCE_DIR@/../Geometry/src \
@CMAKE_CURRENT_SOURCE_DIR@/../ICat/inc/MantidICat \
@CMAKE_CURRENT_SOURCE_DIR@/../ICat/src \
@CMAKE_CURRENT_SOURCE_DIR@/../Kernel/inc/MantidKernel \
@CMAKE_CURRENT_SOURCE_DIR@/../Kernel/src \
@CMAKE_CURRENT_SOURCE_DIR@/../MatlabAPI/src \
@CMAKE_CURRENT_SOURCE_DIR@/../MDAlgorithms/inc/MantidMDAlgorithms \
@CMAKE_CURRENT_SOURCE_DIR@/../MDAlgorithms/src \
@CMAKE_CURRENT_SOURCE_DIR@/../MDEvents/inc/MantidMDEvents \
@CMAKE_CURRENT_SOURCE_DIR@/../MDEvents/src \
@CMAKE_CURRENT_SOURCE_DIR@/../Nexus/inc/MantidNexus \
@CMAKE_CURRENT_SOURCE_DIR@/../Nexus/src \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonAPI/inc/MantidPythonAPI \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonAPI/src \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonInterface/inc/MantidPythonInterface/kernel \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonInterface/inc/MantidPythonInterface/api \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonInterface/mantid/kernel/src \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonInterface/mantid/geometry/src \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonInterface/mantid/api/src \
@CMAKE_CURRENT_SOURCE_DIR@/../TestHelpers/inc/MantidTestHelpers \
@CMAKE_CURRENT_SOURCE_DIR@/../TestHelpers/src \
@CMAKE_CURRENT_SOURCE_DIR@/../WorkflowAlgorithms/inc/MantidWorkflowAlgorithms \
@CMAKE_CURRENT_SOURCE_DIR@/../WorkflowAlgorithms/src

INPUT_ENCODING = UTF-8
FILE_PATTERNS =
RECURSIVE = YES

#Note: The NeXus API docs are there temporarily and cause lots of (unnecessary) doxygen warnings.
# Third party library ANN in Kernel is not doxygenised.
EXCLUDE = @CMAKE_CURRENT_SOURCE_DIR@/../ICat/src/GSoapGenerated \
@CMAKE_CURRENT_SOURCE_DIR@/../ICat/src/GSoap \
@CMAKE_CURRENT_SOURCE_DIR@/../ICat/src/GSoap.cpp \
@CMAKE_CURRENT_SOURCE_DIR@/../ICat/inc/MantidICat/GSoapGenerated \
@CMAKE_CURRENT_SOURCE_DIR@/../ICat/inc/MantidICat/GSoap \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonAPI/src/boostpython.cpp \
@CMAKE_CURRENT_SOURCE_DIR@/../PythonAPI/src/boostpython \
@CMAKE_CURRENT_SOURCE_DIR@/../MDEvents/src/generate_mdevent_declarations.py \
@CMAKE_CURRENT_SOURCE_DIR@/../Kernel/inc/MantidKernel/ANN \
@CMAKE_CURRENT_SOURCE_DIR@/../Kernel/src/ANN \
@CMAKE_CURRENT_SOURCE_DIR@/../Kernel/src/ANN_complete.cpp

EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
HTML_DYNAMIC_SECTIONS = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = YES
MSCGEN_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = NO
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO

0 comments on commit 5657cbf

Please sign in to comment.