fix: doxygen code documentation

dyne · Feb 5, 2024 · e8595c6 · e8595c6
1 parent a303b82
commit e8595c6
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 13 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -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.

diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
diff --git a/doc/Doxyfile b/doc/Doxyfile
@@ -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

diff --git a/include/frei0r.h b/include/frei0r.h
@@ -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