-
Notifications
You must be signed in to change notification settings - Fork 122
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Autodetect doxygen options. Refs #4360.
- Loading branch information
1 parent
5657cbf
commit e859c95
Showing
1 changed file
with
30 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,47 @@ | ||
| set ( USE_DOT OFF CACHE BOOL "Use dot if found on the system for doxygen. Can be slow." ) | ||
|
|
||
| if(DOXYGEN_FOUND) | ||
| # check for dot | ||
| set ( HAVE_DOT NO ) | ||
| if ( DOXYGEN_DOT_EXECUTABLE ) | ||
| if ( USE_DOT ) | ||
| set ( HAVE_DOT YES ) | ||
| endif ( USE_DOT ) | ||
| endif ( DOXYGEN_DOT_EXECUTABLE ) | ||
|
|
||
| # stuff for generating equations | ||
| find_program ( LATEX_EXECUTABLE latex ) | ||
| if ( LATEX_EXECUTABLE ) | ||
| find_program (DVIPS_EXECUTABLE dvips ) | ||
| if ( NOT DVIPS_EXECUTABLE ) | ||
| message ( status " dvips not found...no equations generated. doxygen will complain" ) | ||
| endif ( NOT DVIPS_EXECUTABLE ) | ||
| else ( LATEX_EXECUTABLE ) | ||
| message ( status " latex not found...no equations generated. doxygen will complain" ) | ||
| endif ( LATEX_EXECUTABLE ) | ||
|
|
||
| # check for qtcreator help stuff | ||
| find_program ( QHELP_EXECUTABLE qhelpgenerator ) | ||
| set ( GENERATE_QHELP NO ) | ||
| if ( QHELP_EXECUTABLE ) | ||
| set ( GENERATE_QHELP YES ) | ||
| endif ( QHELP_EXECUTABLE ) | ||
|
|
||
| # configure doxygen | ||
| configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Mantid_template.doxyfile | ||
| ${CMAKE_CURRENT_BINARY_DIR}/Mantid_cmake.doxyfile @ONLY) | ||
| add_custom_target( doxygen # ALL? | ||
| add_custom_target( doxygen # not being added to '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 |