Skip to content

build: add doc target #384

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.

Sign up for GitHub

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

Merged
athre0z merged 2 commits into from
Oct 3, 2022
Merged

build: add doc target #384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2b2587
build: add doc target
Tachi107 Oct 1, 2022
5a49c2d
build(make): use new doc target
Tachi107 Oct 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -440,6 +440,73 @@ if (ZYDIS_BUILD_TOOLS AND NOT ZYAN_NO_LIBC)
endif ()
endif ()

# =============================================================================================== #
# Doxygen documentation #
# =============================================================================================== #
Comment thread
Tachi107 marked this conversation as resolved.

find_package(Doxygen)
if (DOXYGEN_FOUND)
find_file(DOXYGEN_AWESOME_CSS
"doxygen-awesome.css"
PATHS "." ".." "/usr/share"
PATH_SUFFIXES "doxygen-awesome-css"
NO_DEFAULT_PATH
)
find_file(DOXYGEN_AWESOME_SIDEBAR_ONLY_CSS
"doxygen-awesome-sidebar-only.css"
PATHS "." ".." "/usr/share"
PATH_SUFFIXES "doxygen-awesome-css"
NO_DEFAULT_PATH
)

# Read Doxygen options from the Doxyfile and set them as CMake variables
# to accomodate doxygen_add_docs()
file(READ "Doxyfile" DOXYFILE)

@athre0z athre0z Oct 2, 2022

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Nit: this temporary variable DOXYFILE is upper-cased whereas later locals are lower-cased -- is there a reason for this?

# Remove comments
string(REGEX REPLACE "\n?#[^\n]*\n" "" DOXYFILE ${DOXYFILE})
# Remove empty lines
string(REGEX REPLACE "\n[ \t\r\n]" "\n" DOXYFILE "${DOXYFILE}")
# Strip leading and trailing spaces
string(STRIP "${DOXYFILE}" DOXYFILE)
# Tranform the file in a list of '='-separated options
string(REPLACE "\n" ";" DOXYFILE "${DOXYFILE}")

foreach(option IN LISTS DOXYFILE)
string(REPLACE "=" ";" option "${option}")
list(GET option 0 opt_name)
list(GET option 1 opt_value)
string(STRIP "${opt_name}" opt_name)
string(STRIP "${opt_value}" opt_value)

if (opt_name STREQUAL "INPUT")
# Save the INPUTs in a list to be used later
string(REGEX REPLACE "[ ]+" ";" DOC_PATHS "${opt_value}")
# Skip as the input files are not set by a DOXYGEN_INPUT variable
continue()
endif()

if (opt_name STREQUAL "OUTPUT_DIRECTORY")
# Skip as CMake writes the output files in the build directory
continue()
endif()

set("DOXYGEN_${opt_name}" ${opt_value})
endforeach()

set(DOXYGEN_QUIET YES)
set(DOXYGEN_WARNINGS NO)
set(DOXYGEN_WARN_IF_UNDOCUMENTED NO)
set(DOXYGEN_HTML_EXTRA_STYLESHEET "${DOXYGEN_AWESOME_CSS}" "${DOXYGEN_AWESOME_SIDEBAR_ONLY_CSS}")

doxygen_add_docs(doc ${DOC_PATHS} ALL)

install(
DIRECTORY "${CMAKE_CURRENT_BINARY_DIR}/html/"
DESTINATION "${CMAKE_INSTALL_DOCDIR}/api"
COMPONENT Documentation
)
endif()

# =============================================================================================== #
# Manpages #
# =============================================================================================== #
Expand Down
Loading