Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
taosdata
TDengine
提交
ef4f7314
T
TDengine
项目概览
taosdata
/
TDengine
1 年多 前同步成功
通知
1187
Star
22018
Fork
4786
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
1
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
T
TDengine
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
1
Issue
1
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
提交
ef4f7314
编写于
11月 10, 2021
作者:
H
Hongze Cheng
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
refact doxygen generator
上级
9521eca2
变更
4
隐藏空白更改
内联
并排
Showing
4 changed file
with
27 addition
and
25 deletion
+27
-25
CMakeLists.txt
CMakeLists.txt
+1
-22
cmake/cmake.options
cmake/cmake.options
+1
-1
docs/CMakeLists.txt
docs/CMakeLists.txt
+23
-0
docs/Doxyfile.in
docs/Doxyfile.in
+2
-2
未找到文件。
CMakeLists.txt
浏览文件 @
ef4f7314
...
...
@@ -75,27 +75,6 @@ target_include_directories(api INTERFACE "include/client")
add_subdirectory
(
source
)
# docs
# https://vicrucann.github.io/tutorials/quick-cmake-doxygen/
if
(
${
BUILD_DOCS
}
)
find_package
(
Doxygen
)
if
(
DOXYGEN_FOUND
)
# Build the doc
set
(
DOXYGEN_IN
${
CMAKE_SOURCE_DIR
}
/docs/Doxyfile.in
)
set
(
DOXYGEN_OUT
${
CMAKE_BINARY_DIR
}
/Doxyfile
)
configure_file
(
${
DOXYGEN_IN
}
${
DOXYGEN_OUT
}
@ONLY
)
message
(
"Doxygen build start"
)
add_custom_target
(
tdengine_doxygen ALL
COMMAND
${
DOXYGEN_EXECUTABLE
}
${
DOXYGEN_OUT
}
WORKING_DIRECTORY
${
CMAKE_CURRENT_BINARY_DIR
}
COMMENT
"Generating API doxumentation with Doxygen"
VERBATIM
)
else
(
DOXYGEN_FOUND
)
message
(
"Doxygen need to be installed to generate the doxygen documentation"
)
endif
(
DOXYGEN_FOUND
)
endif
(
${
BUILD_DOCS
}
)
add_subdirectory
(
docs
)
# tests (TODO)
cmake/cmake.options
浏览文件 @
ef4f7314
...
...
@@ -40,5 +40,5 @@ option(
option(
BUILD_DOCS
"If use doxygen build documents"
O
N
O
FF
)
\ No newline at end of file
docs/CMakeLists.txt
0 → 100644
浏览文件 @
ef4f7314
# Generate API documentation
## https://vicrucann.github.io/tutorials/quick-cmake-doxygen/
if
(
${
BUILD_DOCS
}
)
find_package
(
Doxygen
)
if
(
DOXYGEN_FOUND
)
# Build the doc
set
(
DOXYGEN_IN
${
CMAKE_SOURCE_DIR
}
/docs/Doxyfile.in
)
set
(
DOXYGEN_OUT
${
CMAKE_BINARY_DIR
}
/Doxyfile
)
configure_file
(
${
DOXYGEN_IN
}
${
DOXYGEN_OUT
}
@ONLY
)
message
(
"Doxygen build start"
)
add_custom_target
(
tdengine_doxygen ALL
COMMAND
${
DOXYGEN_EXECUTABLE
}
${
DOXYGEN_OUT
}
WORKING_DIRECTORY
${
CMAKE_CURRENT_BINARY_DIR
}
COMMENT
"Generating API doxumentation with Doxygen"
VERBATIM
)
else
(
DOXYGEN_FOUND
)
message
(
"Doxygen need to be installed to generate the doxygen documentation"
)
endif
(
DOXYGEN_FOUND
)
endif
(
${
BUILD_DOCS
}
)
\ No newline at end of file
docs/Doxyfile.in
浏览文件 @
ef4f7314
...
...
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.
PROJECT_NAME =
"TDengine"
PROJECT_NAME =
@CMAKE_PROJECT_NAME@
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
...
...
@@ -829,7 +829,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT =
include
source
INPUT =
@CMAKE_SOURCE_DIR@/include @CMAKE_SOURCE_DIR@/
source
# 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
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录