Browse Source

Some changes in docs

Panagiotis Christopoulos Charitos 4 years ago
parent
commit
13331de8a1
5 changed files with 6 additions and 6 deletions
  1. 1 1
      AnKi/Collision/GjkEpa.h
  2. 1 1
      AnKi/Ui.h
  3. 1 1
      AnKi/Util/ClassWrapper.h
  4. 2 2
      CMakeLists.txt
  5. 1 1
      Docs/Doxyfile

+ 1 - 1
AnKi/Collision/GjkEpa.h

@@ -11,7 +11,7 @@
 namespace anki
 {
 
-/// @addtogroup collision_internal
+/// @addtogroup collision
 /// @{
 
 using GjkSupportCallback = Vec4 (*)(const void* shape, const Vec4& dir);

+ 1 - 1
AnKi/Ui.h

@@ -5,7 +5,7 @@
 
 #pragma once
 
-/// @defgroup ui User interface that is using nuklear library.
+/// @defgroup ui User interface that is using the ImGUI library.
 
 #include <AnKi/Ui/UiManager.h>
 #include <AnKi/Ui/Font.h>

+ 1 - 1
AnKi/Util/ClassWrapper.h

@@ -10,7 +10,7 @@
 namespace anki
 {
 
-/// @addtogroup util_misc
+/// @addtogroup util_other
 /// @{
 
 /// A wrapper template to compensate for the fact that some classes get initialized in the constructor but that's not

+ 2 - 2
CMakeLists.txt

@@ -269,14 +269,14 @@ else()
 endif()
 
 # Doxygen
-configure_file(${CMAKE_CURRENT_SOURCE_DIR}/docs/doxyfile ${CMAKE_CURRENT_BINARY_DIR}/doxyfile @ONLY)
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Docs/Doxyfile ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
 
 find_package(Doxygen)
 
 if(DOXYGEN_FOUND)
 	message("++ Doxygen found")
 
-	add_custom_target(doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/doxyfile
+	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()

+ 1 - 1
Docs/doxyfile → Docs/Doxyfile

@@ -743,7 +743,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/src
+INPUT                  = @CMAKE_CURRENT_SOURCE_DIR@/AnKi
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses