From 2865797a32c824aaf4c7305af133f3b1c68ca84c Mon Sep 17 00:00:00 2001 From: "ry.yamafuji" Date: Thu, 11 Dec 2025 01:04:58 +0900 Subject: [PATCH] =?UTF-8?q?Docs=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + docs/Doxyfile | 6 ++---- {src => examples}/c/cp.c | 0 readme/develop.md | 8 ++++++-- src/c/hello.c | 11 ++++++++--- 5 files changed, 17 insertions(+), 9 deletions(-) rename {src => examples}/c/cp.c (100%) diff --git a/.gitignore b/.gitignore index b5c8050..f4ba69f 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +.DS_Store dist/ docs/html/ docs/latex/ diff --git a/docs/Doxyfile b/docs/Doxyfile index 7b929a7..4201796 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -42,7 +42,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "My Project" +PROJECT_NAME = "Dev C And Common C++ Code" # 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 @@ -74,9 +74,7 @@ PROJECT_ICON = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -# OUTPUT_DIRECTORY = -# OUTPUT は docs/html に出す -OUTPUT_DIRECTORY = ./html +OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 # sub-directories (in 2 levels) under the output directory of each output format diff --git a/src/c/cp.c b/examples/c/cp.c similarity index 100% rename from src/c/cp.c rename to examples/c/cp.c diff --git a/readme/develop.md b/readme/develop.md index d0d707a..11073c7 100644 --- a/readme/develop.md +++ b/readme/develop.md @@ -107,6 +107,8 @@ doxygen Doxyfile `docs/Doxyfile`を設定する +* `PROJECT_NAME`を実際のプロジェクト名に変更する + ```sh # ドキュメント化したいディレクトリ INPUT = ../src ../include @@ -114,8 +116,10 @@ INPUT = ../src ../include # INPUT 内を再帰的に探索 RECURSIVE = YES -# OUTPUT は docs/html に出す -OUTPUT_DIRECTORY = ./html +# C向け出力最適化 +OPTIMIZE_OUTPUT_FOR_C = YES +# 全シンボル抽出 +EXTRACT_ALL = YES ``` diff --git a/src/c/hello.c b/src/c/hello.c index c7f028b..d6256ad 100644 --- a/src/c/hello.c +++ b/src/c/hello.c @@ -1,6 +1,11 @@ -/** Hello world program in C -* command: gcc src/hello.c -o dist/hello -* run: ./dist/hello +/** + * @file hello.c + * @brief Hello world program in C + * + * Example build & run: + * @code + * gcc src/c/hello.c -o dist/hello + * @endcode */ #include