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

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

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