Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Add CMake doxygen error check #988 #224

Merged
merged 1 commit into from
Sep 27, 2019

Conversation

nilason
Copy link
Contributor

@nilason nilason commented Sep 16, 2019

This PR adds doxygen error check for CMake builds with a new target (make doxygen-checked), similar to what’s implemented for autotools.

Implemented with only CMake code it’s supposed to work on any platform, but should be tested.

This is a mirror of https://git.osgeo.org/gitea/geos/geos/pulls/95. Opened the PR here too for testing purposes.


add_custom_target(docs
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about registering this as a test, like this?

    add_custom_target(docs
        COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
        DEPENDS geos
        BYPRODUCTS ${DOXYGEN_LOGFILE})

    add_test(NAME test_docs
             COMMAND ${CMAKE_COMMAND}
                 -D DOXYGEN_LOGFILE=${DOXYGEN_LOGFILE}
                 -P "${CMAKE_CURRENT_BINARY_DIR}/${CHECK_ERROR_SCRIPT}")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Makes sense, a test is after all what it is. Updated as recommended.
Thanks!

@nilason nilason force-pushed the add-cmake-doxygen-error-check branch 2 times, most recently from 4ed3a46 to 2f2bbaa Compare September 17, 2019 08:52
@nilason nilason force-pushed the add-cmake-doxygen-error-check branch from 2f2bbaa to 01488a3 Compare September 26, 2019 08:14
@strk strk merged commit 01488a3 into libgeos:master Sep 27, 2019
@nilason nilason deleted the add-cmake-doxygen-error-check branch September 27, 2019 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants