Skip to content

Commit

Permalink
Make doxygen log format configurable. Refs #6582
Browse files Browse the repository at this point in the history
A slightly different style in Visual Studio makes its error parsers
understand the format.
  • Loading branch information
martyngigg committed Feb 18, 2013
1 parent f3d8eaa commit 02e2b4a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
8 changes: 8 additions & 0 deletions Code/Mantid/Framework/Doxygen/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,14 @@ if(DOXYGEN_FOUND)
set ( GENERATE_QHELP YES )
endif ( QHELP_EXECUTABLE )

# Put the warning format in something sensible for the generator we are using
if( MSVC )
# Allows Visual Studio to mark them as if they were compiler warnings and jump straight to them
set ( DOXY_WARN_FORMAT "\"$file($line): $text\"" CACHE STRING "Warning format for doxygen output, which must include surrounding double quotes" )
else()
set ( DOXY_WARN_FORMAT "\"$file:$line: $text \"" CACHE STRING "Warning format for doxygen output, which must include surrounding double quotes" )
endif()

# configure doxygen
add_custom_command ( OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/../../doxygen/html/Mantid_Logo_Transparent.png
COMMAND ${CMAKE_COMMAND} ARGS -E copy_if_different ${CMAKE_SOURCE_DIR}/Images/Mantid_Logo_Transparent.png ${CMAKE_CURRENT_BINARY_DIR}/../../doxygen/html/Mantid_Logo_Transparent.png
Expand Down
2 changes: 1 addition & 1 deletion Code/Mantid/Framework/Doxygen/Mantid_template.doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text "
WARN_FORMAT = @DOXY_WARN_FORMAT@
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
Expand Down

0 comments on commit 02e2b4a

Please sign in to comment.