fix: doxygen code documentation

This commit is contained in:
Jaromil
2024-02-05 09:26:59 +00:00
parent a303b82f34
commit e8595c6cd2
4 changed files with 5 additions and 13 deletions

View File

@@ -38,7 +38,9 @@ INCLUDE( cmake/modules/TargetDistclean.cmake OPTIONAL)
# See this thread for a ridiculous discussion about the simple question how to install a header file with CMake: http://www.cmake.org/pipermail/cmake/2009-October/032874.html
install (DIRECTORY include DESTINATION . FILES_MATCHING PATTERN "frei0r.h" PATTERN "msvc" EXCLUDE)
add_subdirectory (doc)
# For code documentation run: doxygen doc/Doxyfile
# add_subdirectory (doc)
add_subdirectory (src)
# Generate frei0r.pc and install it.

View File

@@ -1,10 +0,0 @@
find_package(Doxygen)
if(DOXYGEN_FOUND)
# configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
add_custom_target(doc
${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
COMMENT "Generating API documentation with Doxygen" VERBATIM
)
endif(DOXYGEN_FOUND)

View File

@@ -568,7 +568,7 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
INPUT = "../include/frei0r.h"
INPUT = "include/frei0r.h"
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

View File

@@ -23,7 +23,7 @@
* @section sec_overview Overview
*
* If you are new to frei0r, the best thing is probably to have
* a look at the <a href="frei0r_8h-source.html">frei0r header</a>,
* a look at the <a href="frei0r_8h_source.html">frei0r header</a>,
* which is quite simple.
*
* After that, you might want to look at the