cdoc finished

comments for brc.c, fav.c
do not allow a board to be added twice in fav


git-svn-id: http://opensvn.csie.org/pttbbs/trunk/pttbbs@2379 63ad8ddf-47c3-0310-b6dd-a9e9d9715204

1 files changed, 24 insertions, 0 deletions

diff --git a/docs/proto/README b/docs/proto/README
new file mode 100644
index 00000000..8b7d2b58
--- /dev/null
+++ b/docs/proto/README
@@ -0,0 +1,24 @@
+Introduction
+============
+
+這個程式可以從 C 的程式碼中，列出所有 statis/non-static 的 functions。
+
+每個 function 前面可以有 javadoc-style 的註解。範例如下：
+
+/**
+ * Function of the function func.
+ * @param x variable, if there are more than one @-style description, it
+ *        will end with the next @-style description.
+ * @return void
+ */
+void func(int x)
+{
+    ...
+}
+
+如果有註解之後沒有接 function 的話，會原封不動丟出來。
+
+Usage
+=====
+    make 產生 documents
+    make clean 清除 documents