139 lines
11 KiB
HTML
139 lines
11 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>uIP 1.0: uip-code-style.c</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.4.6 -->
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="classes.html"><span>Data Structures</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li><a href="examples.html"><span>Examples</span></a></li>
|
|
</ul></div>
|
|
<h1>uip-code-style.c</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This is the official code style of uIP. */</span>
|
|
<a name="l00002"></a>00002 <span class="comment"></span>
|
|
<a name="l00003"></a>00003 <span class="comment">/**</span>
|
|
<a name="l00004"></a>00004 <span class="comment"> * \defgroup codestyle Coding style</span>
|
|
<a name="l00005"></a>00005 <span class="comment"> *</span>
|
|
<a name="l00006"></a>00006 <span class="comment"> * This is how a Doxygen module is documented - start with a \defgroup</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> * Doxygen keyword at the beginning of the file to define a module,</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> * and use the \addtogroup Doxygen keyword in all other files that</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> * belong to the same module. Typically, the \defgroup is placed in</span>
|
|
<a name="l00010"></a>00010 <span class="comment"> * the .h file and \addtogroup in the .c file.</span>
|
|
<a name="l00011"></a>00011 <span class="comment"> *</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> * @{</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> */</span>
|
|
<a name="l00014"></a>00014 <span class="comment"></span>
|
|
<a name="l00015"></a>00015 <span class="comment">/**</span>
|
|
<a name="l00016"></a>00016 <span class="comment"> * \file</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> * A brief description of what this file is.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"> * \author</span>
|
|
<a name="l00019"></a>00019 <span class="comment"> * Adam Dunkels <adam@sics.se></span>
|
|
<a name="l00020"></a>00020 <span class="comment"> *</span>
|
|
<a name="l00021"></a>00021 <span class="comment"> * Every file that is part of a documented module has to have</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> * a \file block, else it will not show up in the Doxygen</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> * "Modules" * section.</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> */</span>
|
|
<a name="l00025"></a>00025
|
|
<a name="l00026"></a>00026 <span class="comment">/* Single line comments look like this. */</span>
|
|
<a name="l00027"></a>00027
|
|
<a name="l00028"></a>00028 <span class="comment">/*</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * Multi-line comments look like this. Comments should prefferably be</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> * full sentences, filled to look like real paragraphs.</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> */</span>
|
|
<a name="l00032"></a>00032
|
|
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="a00136.html">uip.h</a>"</span>
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a>00035 <span class="comment">/*</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * Make sure that non-global variables are all maked with the static</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * keyword. This keeps the size of the symbol table down.</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> */</span>
|
|
<a name="l00039"></a>00039 <span class="keyword">static</span> <span class="keywordtype">int</span> flag;
|
|
<a name="l00040"></a>00040
|
|
<a name="l00041"></a>00041 <span class="comment">/*</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * All variables and functions that are visible outside of the file</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> * should have the module name prepended to them. This makes it easy</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * to know where to look for function and variable definitions.</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> *</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> * Put dividers (a single-line comment consisting only of dashes)</span>
|
|
<a name="l00047"></a>00047 <span class="comment"> * between functions.</span>
|
|
<a name="l00048"></a>00048 <span class="comment"> */</span>
|
|
<a name="l00049"></a>00049 <span class="comment">/*---------------------------------------------------------------------------*/</span><span class="comment"></span>
|
|
<a name="l00050"></a>00050 <span class="comment">/**</span>
|
|
<a name="l00051"></a>00051 <span class="comment"> * \brief Use Doxygen documentation for functions.</span>
|
|
<a name="l00052"></a>00052 <span class="comment"> * \param c Briefly describe all parameters.</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> * \return Briefly describe the return value.</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> * \retval 0 Functions that return a few specified values</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> * \retval 1 can use the \retval keyword instead of \return.</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> *</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * Put a longer description of what the function does</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> * after the preamble of Doxygen keywords.</span>
|
|
<a name="l00059"></a>00059 <span class="comment"> *</span>
|
|
<a name="l00060"></a>00060 <span class="comment"> * This template should always be used to document</span>
|
|
<a name="l00061"></a>00061 <span class="comment"> * functions. The text following the introduction is used</span>
|
|
<a name="l00062"></a>00062 <span class="comment"> * as the function's documentation.</span>
|
|
<a name="l00063"></a>00063 <span class="comment"> *</span>
|
|
<a name="l00064"></a>00064 <span class="comment"> * Function prototypes have the return type on one line,</span>
|
|
<a name="l00065"></a>00065 <span class="comment"> * the name and arguments on one line (with no space</span>
|
|
<a name="l00066"></a>00066 <span class="comment"> * between the name and the first parenthesis), followed</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> * by a single curly bracket on its own line.</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> */</span>
|
|
<a name="l00069"></a>00069 <span class="keywordtype">void</span>
|
|
<a name="l00070"></a>00070 code_style_example_function(<span class="keywordtype">void</span>)
|
|
<a name="l00071"></a>00071 {
|
|
<a name="l00072"></a>00072 <span class="comment">/*</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> * Local variables should always be declared at the start of the</span>
|
|
<a name="l00074"></a>00074 <span class="comment"> * function.</span>
|
|
<a name="l00075"></a>00075 <span class="comment"> */</span>
|
|
<a name="l00076"></a>00076 <span class="keywordtype">int</span> i; <span class="comment">/* Use short variable names for loop</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> counters. */</span>
|
|
<a name="l00078"></a>00078
|
|
<a name="l00079"></a>00079 <span class="comment">/*</span>
|
|
<a name="l00080"></a>00080 <span class="comment"> * There should be no space between keywords and the first</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> * parenthesis. There should be spaces around binary operators, no</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> * spaces between a unary operator and its operand.</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> *</span>
|
|
<a name="l00084"></a>00084 <span class="comment"> * Curly brackets following for(), if(), do, and case() statements</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * should follow the statement on the same line.</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> */</span>
|
|
<a name="l00087"></a>00087 <span class="keywordflow">for</span>(i = 0; i < 10; ++i) {
|
|
<a name="l00088"></a>00088 <span class="comment">/*</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> * Always use full blocks (curly brackets) after if(), for(), and</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> * while() statements, even though the statement is a single line</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> * of code. This makes the code easier to read and modifications</span>
|
|
<a name="l00092"></a>00092 <span class="comment"> * are less error prone.</span>
|
|
<a name="l00093"></a>00093 <span class="comment"> */</span>
|
|
<a name="l00094"></a>00094 <span class="keywordflow">if</span>(i == c) {
|
|
<a name="l00095"></a>00095 <span class="keywordflow">return</span> c; <span class="comment">/* No parentesis around return values. */</span>
|
|
<a name="l00096"></a>00096 } <span class="keywordflow">else</span> { <span class="comment">/* The else keyword is placed inbetween</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> curly brackers, always on its own line. */</span>
|
|
<a name="l00098"></a>00098 c++;
|
|
<a name="l00099"></a>00099 }
|
|
<a name="l00100"></a>00100 }
|
|
<a name="l00101"></a>00101 }
|
|
<a name="l00102"></a>00102 <span class="comment">/*---------------------------------------------------------------------------*/</span>
|
|
<a name="l00103"></a>00103 <span class="comment">/*</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> * Static (non-global) functions do not need Doxygen comments. The</span>
|
|
<a name="l00105"></a>00105 <span class="comment"> * name should not be prepended with the module name - doing so would</span>
|
|
<a name="l00106"></a>00106 <span class="comment"> * create confusion.</span>
|
|
<a name="l00107"></a>00107 <span class="comment"> */</span>
|
|
<a name="l00108"></a>00108 <span class="keyword">static</span> <span class="keywordtype">void</span>
|
|
<a name="l00109"></a>00109 an_example_function(<span class="keywordtype">void</span>)
|
|
<a name="l00110"></a>00110 {
|
|
<a name="l00111"></a>00111
|
|
<a name="l00112"></a>00112 }
|
|
<a name="l00113"></a>00113 <span class="comment">/*---------------------------------------------------------------------------*/</span>
|
|
<a name="l00114"></a>00114
|
|
<a name="l00115"></a>00115 <span class="comment">/* The following stuff ends the \defgroup block at the beginning of</span>
|
|
<a name="l00116"></a>00116 <span class="comment"> the file: */</span>
|
|
<a name="l00117"></a>00117 <span class="comment"></span>
|
|
<a name="l00118"></a>00118 <span class="comment">/** @} */</span>
|
|
</pre></div> <hr size="1"><address style="align: right;"><small>Generated on Mon Jun 12 10:23:01 2006 for uIP 1.0 by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
|
|
</body>
|
|
</html>
|