• R/O
  • SSH
  • HTTPS

ttssh2: Commit


Commit MetaInfo

Revision8841 (tree)
Time2020-07-06 22:54:06
Authorzmatsuo

Log Message

内部ドキュメント作成用フォルダ

- プログラムの作成/理解をサポートするためのドキュメントを生成する
- doxygen / global

Change Summary

Incremental Difference

--- trunk/CMakeLists.txt (revision 8840)
+++ trunk/CMakeLists.txt (revision 8841)
@@ -156,4 +156,5 @@
156156 endif()
157157 add_subdirectory(installer)
158158 add_subdirectory(doc)
159+add_subdirectory(doc_internal)
159160 add_subdirectory(tools)
--- trunk/doc_internal/.gitignore (nonexistent)
+++ trunk/doc_internal/.gitignore (revision 8841)
@@ -0,0 +1,2 @@
1+global/
2+doxygen/
--- trunk/doc_internal/CMakeLists.txt (nonexistent)
+++ trunk/doc_internal/CMakeLists.txt (revision 8841)
@@ -0,0 +1,38 @@
1+find_package(Doxygen)
2+message("doxygen=${DOXYGEN_EXECUTABLE}")
3+
4+if(NOT DOXYGEN_FOUND)
5+ message(warning "doxygen not found")
6+else()
7+ add_custom_target(
8+ doxygen
9+ ${DOXYGEN_EXECUTABLE} Doxyfile
10+ WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/doxygen
11+ )
12+
13+ set_target_properties(
14+ doxygen
15+ PROPERTIES FOLDER doc_internal)
16+endif()
17+
18+
19+find_program(GTAGS gtags)
20+find_program(HTAGS htags)
21+message("GTAGS=${GTAGS}")
22+message("HTAGS=${HTAGS}")
23+
24+if(("${GTAGS}" STREQUAL "GTAGS-NOTFOUND") OR ("${HTAGS}" STREQUAL "HTAGS-NOTFOUND"))
25+ message(warning "global not found")
26+else()
27+ add_custom_target(
28+ global
29+ COMMAND ${GTAGS}
30+ COMMAND ${CMAKE_COMMAND} -E make_directory ${CMAKE_CURRENT_SOURCE_DIR}/global
31+ COMMAND ${HTAGS} -ans --tabs 4 -F -d ${CMAKE_CURRENT_SOURCE_DIR}/.. ${CMAKE_CURRENT_SOURCE_DIR}/global
32+ WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/..
33+ )
34+
35+ set_target_properties(
36+ global
37+ PROPERTIES FOLDER doc_internal)
38+endif()
--- trunk/doc_internal/build.bat (nonexistent)
+++ trunk/doc_internal/build.bat (revision 8841)
@@ -0,0 +1,4 @@
1+cd /d %~dp0
2+path c:\cygwin64\bin;%PATH%
3+bash build.sh
4+pause
--- trunk/doc_internal/build.sh (nonexistent)
+++ trunk/doc_internal/build.sh (revision 8841)
@@ -0,0 +1,5 @@
1+# doxygen
2+(cd doxygen; doxygen Doxyfile)
3+
4+# global
5+(rm -rf global; mkdir global; cd ..; gtags; htags -ans --tabs 4 -F; mv HTML/* doc_internal/global)
--- trunk/doc_internal/index.html (nonexistent)
+++ trunk/doc_internal/index.html (revision 8841)
@@ -0,0 +1,11 @@
1+<html>
2+<list>
3+ <li><a href="doxygen/html/index.html">doxygen</a></li>
4+ <li><a href="global/HTML/index.html">global</a></li>
5+</list>
6+<list>
7+ <li>doc
8+ <a href="../doc/en/html/index.html">en</a> /
9+ <a href="../doc/ja/html/index.html">ja</a> </li>
10+</list>
11+</html>
--- trunk/doc_internal/readme.md (nonexistent)
+++ trunk/doc_internal/readme.md (revision 8841)
@@ -0,0 +1,18 @@
1+# 内部ドキュメント
2+
3+プログラムを読んだり作成するときに便利なドキュメントを作成します。
4+
5+dogygen, global, cygwin が使える状態で、build.bat を実行すると
6+./index.html からドキュメントを参照できます。
7+
8+# cmake ビルド
9+
10+## doxygen
11+
12+doxygen ターゲットをビルドするとドキュメントが作成されます。
13+ツールが見つからない場合、doxygen ターゲットは生成されません。
14+
15+## global
16+
17+global ターゲットをビルドすると作成されます
18+ツールが見つからない場合、global ターゲットは生成されません。
Show on old repository browser