Docs修正

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 dist/
 docs/html/
 docs/latex/

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_DIRECTORY       =
-# OUTPUT は docs/html に出す
-OUTPUT_DIRECTORY = ./html
 
 # 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

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 に出す
+# C向け出力最適化
-OUTPUT_DIRECTORY = ./html
+OPTIMIZE_OUTPUT_FOR_C = YES
+# 全シンボル抽出
+EXTRACT_ALL = YES
 ```
 
 

src/c/hello.c

@@ -1,6 +1,11 @@
-/** Hello world program in C
+/** 
-*   command: gcc src/hello.c -o dist/hello
+ * @file hello.c
-*   run: ./dist/hello
+ * @brief Hello world program in C
+ *
+ * Example build & run:
+ * @code
+ * gcc src/c/hello.c -o dist/hello
+ * @endcode
 */
 #include <stdio.h>