Skip to content

Commit

Permalink
Only skip *.cpp files for doc generation on travis
Browse files Browse the repository at this point in the history
  • Loading branch information
m-kuhn committed Jan 7, 2016
1 parent f8f056e commit 2b7c5c1
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion ci/travis/linux/install.sh
Expand Up @@ -15,7 +15,9 @@ cmake -DWITH_SERVER=ON \
-DENABLE_PGTEST=ON \
-DWITH_QWTPOLAR=OFF \
-DWITH_APIDOC=ON \
-DDOXYGEN_FILE_PATTERN="*.h" \
-DWITH_ASTYLE=ON \
-DWITH_PYSPATIALITE=ON \
-DGRASS_PREFIX7=/usr/lib/grass70 \
-DGRASS_INCLUDE_DIR7=/usr/lib/grass70/include ..
-DGRASS_INCLUDE_DIR7=/usr/lib/grass70/include \
..
3 changes: 1 addition & 2 deletions cmake_templates/Doxyfile.in
Expand Up @@ -622,8 +622,7 @@ INPUT_ENCODING = UTF-8
# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx
# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90

FILE_PATTERNS = *.h \
*.dox
FILE_PATTERNS = @DOXYGEN_FILE_PATTERN@

# The RECURSIVE tag can be used to turn specify whether or not subdirectories
# should be searched for input files as well. Possible values are YES and NO.
Expand Down
1 change: 1 addition & 0 deletions doc/CMakeLists.txt
Expand Up @@ -40,6 +40,7 @@ IF(WITH_APIDOC)
SET(DOXYGEN_TAGS ${QT_TAG_FILE}=${QT_DOC_URL})
ENDIF(QT_TAG_FILE)

SET (DOXYGEN_FILEPATTERN "*.cpp *.h *.dox" CACHE STRING "File pattern to be parsed by doxygen.")
CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/cmake_templates/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
ADD_CUSTOM_TARGET(apidoc ALL
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
Expand Down

3 comments on commit 2b7c5c1

@nyalldawson
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@m-kuhn I wonder if this whole change should be reverted. Given that the actual docs are built using the cpp files too, it seems pointless to not test these on Travis. Otherwise we get test failures on the nightly builds but not Travis...

@m-kuhn
Copy link
Member Author

@m-kuhn m-kuhn commented on 2b7c5c1 Jan 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The point for this was to exclude doxymentation in cpp files from the public API (since they are not public API) and from the documentation coverage threshold.

@nyalldawson
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@m-kuhn yes, but isn't the public doxygen docs generated from the nightly builds? So they would still including any classes defined in a .cpp file. I'd prefer to keep checking them in Travis, so we know that they need to be @cond'ed out to avoid them appearing in any public docs...

Please sign in to comment.