Skip to content

Commit

Permalink
Add DOCUMENTATION.md (#667)
Browse files Browse the repository at this point in the history
Adds the C++ `DOCUMENTATION.md`, covering the use of Doxygen for documenting the code. Copied mostly from libcudf.

Contributes to #598

Authors:
  - Mark Harris (https://github.com/harrism)

Approvers:
  - H. Thomson Comer (https://github.com/thomcom)
  - Michael Wang (https://github.com/isVoid)
  - Robert Maynard (https://github.com/robertmaynard)

URL: #667
  • Loading branch information
harrism authored Sep 28, 2022
1 parent 5d84d9e commit d5f2032
Show file tree
Hide file tree
Showing 2 changed files with 599 additions and 0 deletions.
24 changes: 24 additions & 0 deletions cpp/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -277,3 +277,27 @@ rapids_export(
NAMESPACE cuspatial::
DOCUMENTATION doc_string
)


# ##################################################################################################
# * build documentation ----------------------------------------------------------------------------

find_package(Doxygen)
if(Doxygen_FOUND)

# doc targets for cuDF
add_custom_command(
OUTPUT CUSPATIAL_DOXYGEN
WORKING_DIRECTORY ${CUSPATIAL_SOURCE_DIR}/doxygen
COMMAND ${DOXYGEN_EXECUTABLE} Doxyfile
VERBATIM
COMMENT "Custom command for building cuspatial doxygen docs."
)

add_custom_target(
docs_cuspatial
DEPENDS CUSPATIAL_DOXYGEN
COMMENT "Custom command for building cuspatial doxygen docs."
)

endif()
Loading

0 comments on commit d5f2032

Please sign in to comment.