summaryrefslogtreecommitdiffstats
path: root/docs/proto/README
blob: 8b7d2b58412dd22bb048e2c77575d34703234989 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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