blob: a96d3dc19d4985f4f1db6df019646fe0392da26b (
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
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
|
Document the code with Doxygen
Documenting structs
1 /**
2 * A structure to represent 3d vectors
3 */
4 typedef struct
5 {
6 /*@{*/
7 double x ; /**< the x coordinate */
8 double y ; /**< the y coordinate */
9 double z ; /**< the z coordinate */
10 /*@}*/
11 /**
12 * @name group 2
13 */
14 /*@{*/
15 char * name ; /**< the name of the point */
16 int namelength ; /**< the size of the point name */
17 /*@}*/
18 } point3d ;
Documenting enums
1 /**
2 * The enumeration of space dimension
3 */
4 typedef enum
5 {
6 UND, /**< 1D */
7 DEUXD, /**< 2D */
8 TROISD /**< 3D */
9 } dimensions ;
Documenting functions
1 /*!
2 Copies bytes from a source memory area to a destination memory area,
3 where both areas may not overlap.
4 @param[out] dest The memory area to copy to.
5 @param[in] src The memory area to copy from.
6 @param[in] n The number of bytes to copy
7 */
8 void memcpy(void *dest, const void *src, size_t n);
1 /**
2 * The point3d structure is stupid
3 * @param[out] x the modified input
4 * @return \f$x + 1\f$
5 */
6 int megaFunc( int * x ) ;
7 /**
8 * The main procedure. It can do the following:
9 * - do nothing
10 * - sleep
11 *
12 * @code
13 * for ( i = 0 ; i < 5 ; i++ ) { megaFunc(i) ; }
14 * @endcode
15 * Which compute \f$(x_1,y_1)\f$ sometimes.
16 * @param argc the command line
17 * @param argv the number of options in the command line.
18 * @return whatever
19 * @author jb silvy
20 */
21 int main( char ** argc, int argv )
22 {
23 return megaFunc( 3 ) ;
24 }
Documenting others
1 /**
2 * scilab version
3 */
4 #define VERSION 5.0
|
