From e2abe0b251255ace66670b46f822b382c7492726 Mon Sep 17 00:00:00 2001 From: Simon Lynen Date: Thu, 27 Mar 2014 10:24:45 +0100 Subject: [PATCH] doxygen warning output non documented members --- .gitignore | 1 + CMakeLists.txt | 5 +++++ make_doxygen | 2 +- msf_core/CMakeLists.txt | 8 ++++++++ msf_dox.dox | 24 ++++++++++++------------ 5 files changed, 27 insertions(+), 13 deletions(-) create mode 100644 CMakeLists.txt diff --git a/.gitignore b/.gitignore index 7477225d..f50d6986 100644 --- a/.gitignore +++ b/.gitignore @@ -22,6 +22,7 @@ msf_core/cfg/cpp/ .settings doc html +documentation *.cfgc *.dox *.wikidoc diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 00000000..84e25728 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,5 @@ +cmake_minimum_required(VERSION 2.8.3) +project(ethzasl_msf) +find_package(catkin REQUIRED) + +catkin_metapackage() \ No newline at end of file diff --git a/make_doxygen b/make_doxygen index 10fba5f3..70c1c589 100755 --- a/make_doxygen +++ b/make_doxygen @@ -1,6 +1,6 @@ #!/bin/bash doxygen msf_dox.dox -cd html +cd documentation git add . git commit -m "Updated documentation." git push origin gh-pages diff --git a/msf_core/CMakeLists.txt b/msf_core/CMakeLists.txt index 1f8e2b3c..944ea23d 100644 --- a/msf_core/CMakeLists.txt +++ b/msf_core/CMakeLists.txt @@ -15,6 +15,14 @@ find_package(catkin REQUIRED COMPONENTS sensor_msgs dynamic_reconfigure msf_timi find_package(Eigen REQUIRED) find_package(GLog REQUIRED) +find_package(Doxygen) +if(DOXYGEN_FOUND) + set(MSF_DOCUMENTATION msf_documentation) + add_custom_target(${MSF_DOCUMENTATION} + COMMAND doxygen msf_dox.dox + WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/../) +endif(DOXYGEN_FOUND) + include_directories(include ${Eigen_INCLUDE_DIRS} ${catkin_INCLUDE_DIRS}) SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra -Werror -Wno-unused-parameter") diff --git a/msf_dox.dox b/msf_dox.dox index 7d8bb5fa..37d4cea9 100644 --- a/msf_dox.dox +++ b/msf_dox.dox @@ -32,7 +32,7 @@ PROJECT_NAME = "ethzasl-msf - Modular Sensor Fusion" # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer @@ -52,7 +52,7 @@ PROJECT_LOGO = # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. -OUTPUT_DIRECTORY = html +OUTPUT_DIRECTORY = documentation # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output @@ -88,7 +88,7 @@ BRIEF_MEMBER_DESC = YES # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. -REPEAT_BRIEF = NO +REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string @@ -151,7 +151,7 @@ SHORT_NAMES = NO # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style @@ -346,17 +346,17 @@ LOOKUP_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = YES +EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. -EXTRACT_PRIVATE = YES +EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = YES +EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. @@ -694,7 +694,7 @@ EXCLUDE_SYMLINKS = NO # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = "*/.*" "*/.*/*" # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -708,7 +708,7 @@ EXCLUDE_SYMBOLS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -1242,7 +1242,7 @@ COMPACT_LATEX = NO # by the printer. Possible values are: a4, letter, legal and # executive. If left blank a4wide will be used. -PAPER_TYPE = a4 +PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. @@ -1281,7 +1281,7 @@ USE_PDFLATEX = YES # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. -LATEX_BATCHMODE = NO +LATEX_BATCHMODE = YES # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) @@ -1614,7 +1614,7 @@ DOT_NUM_THREADS = 0 # the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the # directory containing the font. -DOT_FONTNAME = Helvetica +DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt.