*** Documentation access *** Open ./docs/index.html to open the start page or ./docs/html/index.html in order to access directly the doxigen documentation. *** Documentation rebuild procedure *** The following software must be installed: - Doxygen 1.5.7.1 or later. - Graphviz 2.21 or later. The ./bin directory must be specified in the path in order to make Graphviz accessible by Doxygen. Build procedure: - Run Doxywizard. - Load ./docs/Doxyfile from Doxywizard. - Start. *** Doxygen usage rules *** - The JavaDoc style is recommended (@ instad of \, /** instead of /*!). - Params descriptions must not begin with a capital letter and must not be terminated with a dot unless it is composed of multiple paragraphs. - Retvals descriptions must not begin with a capital letter but must be terminated by a dot. - Normal paragraphs, return rescriptions and notes must start with a capital letter and must be terminated with a dot. - Multiple return values should be listed using the @retval command. - Parameters direction must be specified. Examples: @note This is a note. @retval RDY_OK is a possible return value. @return The pointer to the created thread is returned. @param[in] n the number of bytes to be written @param[in] n the number of bytes to be written. This value can be zero. staging-4.3 xenJames
aboutsummaryrefslogtreecommitdiffstats
path: root/tools/vtpm/Makefile
blob: aeab129cbb15969f95df23bd2acd4643025d7dd5 (plain) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94