-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathstdcomments.h
79 lines (66 loc) · 2.11 KB
/
stdcomments.h
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
//These comment formats below are a mixture of doxygen and javadocs, primarily steered towards doxygen
//...
//WISP Rule #1: Thou Shalt Comment
//WISP Rule #2: Thou Shalt Punish Those Who Don't Comment
/************************************************************************************************************************************/
/** @file x
* @brief x
* @details x
*
* @author Justin Reina, UW Sensors and Systems Lab
* @created x
* @last rev x
*
*
* @notes x
*
* @section Opens
* none current
*
*/
/************************************************************************************************************************************/
/************************************************************************************************************************************/
/** @fcn int main(void)
* @brief x
* @details x
*
* @section Purpose
* x
*
* @param [in] name descrip
*
* @param [out] name descrip
*
* @return (type) descrip
*
* @pre x
*
* @post x
*
* @section Operation
* x
*
* @section Opens
* x
*
* @section Hazards & Risks
* x
*
* @section Todo
* x
*
* @section Timing
* x
*
* @note x
*/
/************************************************************************************************************************************/
//------------------------------------------------------------A Delimiting Note-----------------------------------------------------//
/************************************************************************************************************************************/
// SECTION HEADER *
//***********************************************************************************************************************************/
/* note to the side */
// a note on top
// that spans multiple lines
// PROTOTYPES, DECLARATIONS AND PREPROC---------------------------------------------------------------------------------------------//
//[1/x]-------------------------------------------STEP 1----------------------------------------------------------------------------//