doc: add Doxygen build system
- add Doxygen build configuration file template and CMake list file. - add option for building documentation. - the content of documentation should be filled in future.
This commit is contained in:
parent
b6c53ac707
commit
ab12268395
1
.gitattributes
vendored
Normal file
1
.gitattributes
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
Doxyfile.in eol=lf
|
|
@ -6,12 +6,16 @@ project(YYCC
|
|||
|
||||
# Provide options
|
||||
option(YYCC_BUILD_TESTBENCH "Build testbench of YYCCommonplace." OFF)
|
||||
option(YYCC_BUILD_DOC "Build document of YYCCommonplace." OFF)
|
||||
|
||||
# Import 2 build targets
|
||||
add_subdirectory(src)
|
||||
if (YYCC_BUILD_TESTBENCH)
|
||||
add_subdirectory(testbench)
|
||||
endif ()
|
||||
if (YYCC_BUILD_DOC)
|
||||
add_subdirectory(doc)
|
||||
endif ()
|
||||
|
||||
# Install project package infos
|
||||
# Package target
|
||||
|
|
6
doc/CMakeLists.txt
Normal file
6
doc/CMakeLists.txt
Normal file
|
@ -0,0 +1,6 @@
|
|||
# Configure Doxygen config file
|
||||
configure_file(
|
||||
${CMAKE_CURRENT_LIST_DIR}/Doxyfile.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/Doxyfile
|
||||
@ONLY
|
||||
)
|
2774
doc/Doxyfile.in
Normal file
2774
doc/Doxyfile.in
Normal file
File diff suppressed because it is too large
Load Diff
10
doc/src/index.dox
Normal file
10
doc/src/index.dox
Normal file
|
@ -0,0 +1,10 @@
|
|||
/**
|
||||
|
||||
\mainpage YYCCommonplace Library Manual
|
||||
|
||||
This manual is organized into the following chapters and appendices:
|
||||
|
||||
\subpage intro
|
||||
|
||||
|
||||
*/
|
11
doc/src/intro.dox
Normal file
11
doc/src/intro.dox
Normal file
|
@ -0,0 +1,11 @@
|
|||
/**
|
||||
|
||||
\page intro Introduction to YYCCommonplace
|
||||
|
||||
work in progress
|
||||
|
||||
\section work in progress
|
||||
|
||||
work in progress
|
||||
|
||||
*/
|
Loading…
Reference in New Issue
Block a user