Документация

This commit is contained in:
Andrei Astafev 2019-10-13 09:29:02 +03:00
parent 26ac40a8b5
commit 9e9b2b40f7
7 changed files with 25 additions and 22 deletions

View File

@ -46,6 +46,7 @@ add_subdirectory(src/myx/base)
add_subdirectory(src/myx/filesystem)
add_subdirectory(src/myx/log)
add_subdirectory(src/myx/qt)
add_subdirectory(doc)
# Примеры
if (BUILD_EXAMPLES)
@ -61,21 +62,3 @@ ExternalProject_Add(whereami
CONFIGURE_COMMAND ${CMAKE_COMMAND} -"G${CMAKE_GENERATOR}" -DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=${CMAKE_C_COMPILER} -DCMAKE_CXX_COMPILER=${CMAKE_CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${CMAKE_BINARY_DIR} -DBUILD_SHARED_LIBS=OFF -DBUILD_EXAMPLES=OFF <SOURCE_DIR>
)
add_breathe_target(
TARGET_NAME doc-breathe
SOURCE_DIR ${CMAKE_SOURCE_DIR}/doc/html
DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/html/Doxyfile.in
CONF_FILE ${CMAKE_SOURCE_DIR}/doc/html/conf.py.in
CACHE_DIR ${CMAKE_BINARY_DIR}/_doctrees
BUILD_DIR ${CMAKE_BINARY_DIR}/doc/breathe
HTML_DIR ${CMAKE_BINARY_DIR}/doc/breathe
COMMENT "Documentation in HTML format with Breathe generator"
)
add_doxygen_target(
TARGET_NAME doc-doxygen
DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/html/Doxyfile.in
OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/doc
HTML YES
LATEX YES
)

@ -1 +1 @@
Subproject commit 0a2d9a4fceb445843be62247f77da098faf7ba12
Subproject commit 156d74f581cac0771f3c05411fd0d79f811afc55

20
doc/CMakeLists.txt Normal file
View File

@ -0,0 +1,20 @@
add_breathe_target(
TARGET_NAME doc-breathe
SOURCE_DIR ${CMAKE_SOURCE_DIR}/doc/breathe
DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/Doxyfile.in
CONF_FILE ${CMAKE_SOURCE_DIR}/doc/breathe/conf.py.in
OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc/breathe
COMMENT "Documentation in HTML format with Breathe generator"
)
add_doxygen_target(
TARGET_NAME doc-doxygen
SOURCE_DIR ${CMAKE_SOURCE_DIR}/src
DOXY_FILE ${CMAKE_SOURCE_DIR}/doc/Doxyfile.in
OUTPUT_DIR ${CMAKE_BINARY_DIR}/doc
HTML YES
LATEX YES
COMMENT "Documentation in HTML and LaTeX format with Doxygen"
)

View File

@ -11,7 +11,7 @@ PROJECT_LOGO =
OUTPUT_DIRECTORY = @OUTPUT_DIRECTORY@
CREATE_SUBDIRS = NO
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = Russian
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
@ -28,8 +28,8 @@ ABBREVIATE_BRIEF = "The $name class" \
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/src
STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/src
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO