Project

General

Profile

Revision 1380

Added by Chris Mar over 14 years ago

fixed doxygen problems in wireless library, added new docs

View differences:

group__wlerror.html
1 1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 2
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3 3
<title>libwireless: Error Packets</title>
4
<link href="tabs.css" rel="stylesheet" type="text/css">
4 5
<link href="doxygen.css" rel="stylesheet" type="text/css">
5
<link href="tabs.css" rel="stylesheet" type="text/css">
6 6
</head><body>
7
<!-- Generated by Doxygen 1.5.3 -->
8
<div class="tabs">
9
  <ul>
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11
    <li><a href="modules.html"><span>Modules</span></a></li>
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
13
    <li><a href="files.html"><span>Files</span></a></li>
14
  </ul>
7
<!-- Generated by Doxygen 1.5.9 -->
8
<div class="navigation" id="top">
9
  <div class="tabs">
10
    <ul>
11
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
12
      <li><a href="modules.html"><span>Modules</span></a></li>
13
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
14
      <li><a href="files.html"><span>Files</span></a></li>
15
    </ul>
16
  </div>
15 17
</div>
18
<div class="contents">
16 19
<h1>Error Packets</h1>Functions for sending and receiving error packets.  
17
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
20
<a href="#_details">More...</a>
21
<p>
22
<table border="0" cellpadding="0" cellspacing="0">
18 23
<tr><td></td></tr>
19 24
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
20 25
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wlerror.html#g3217351e71b892a90ed3ba79ed36e354">wl_error_register</a> (void)</td></tr>
......
28 33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a string in an error packet.  <a href="#g01c7382a758876fce52c18a3e6c81534"></a><br></td></tr>
29 34
</table>
30 35
<hr><a name="_details"></a><h2>Detailed Description</h2>
31
Functions for sending and receiving error packets. 
32
<p>
33 36
Functions for sending and receiving error packets. <hr><h2>Function Documentation</h2>
34 37
<a class="anchor" name="g3217351e71b892a90ed3ba79ed36e354"></a><!-- doxytag: member="wl_error_group.h::wl_error_register" ref="g3217351e71b892a90ed3ba79ed36e354" args="(void)" -->
35 38
<div class="memitem">
......
41 44
          <td class="paramtype">void&nbsp;</td>
42 45
          <td class="paramname">          </td>
43 46
          <td>&nbsp;)&nbsp;</td>
44
          <td width="100%"></td>
47
          <td></td>
45 48
        </tr>
46 49
      </table>
47 50
</div>
......
51 54
Register this packet group with the wireless library. 
52 55
<p>
53 56
Register this packet group with the wireless library. This function must be called before any other wl_error function. 
57
<p>References <a class="el" href="wireless_8c_source.html#l00342">wl_register_packet_group()</a>.</p>
58

  
54 59
</div>
55 60
</div><p>
56 61
<a class="anchor" name="g01c7382a758876fce52c18a3e6c81534"></a><!-- doxytag: member="wl_error_group.h::wl_error_send_string" ref="g01c7382a758876fce52c18a3e6c81534" args="(char *str)" -->
......
63 68
          <td class="paramtype">char *&nbsp;</td>
64 69
          <td class="paramname"> <em>str</em>          </td>
65 70
          <td>&nbsp;)&nbsp;</td>
66
          <td width="100%"></td>
71
          <td></td>
67 72
        </tr>
68 73
      </table>
69 74
</div>
......
79 84
  </table>
80 85
</dl>
81 86

  
87
<p>References <a class="el" href="wireless_8c_source.html#l00285">wl_send_global_packet()</a>.</p>
88

  
82 89
</div>
83 90
</div><p>
84 91
<a class="anchor" name="g4c737d93fefc9aa8d4f87c9296bfa8a0"></a><!-- doxytag: member="wl_error_group.h::wl_error_unregister" ref="g4c737d93fefc9aa8d4f87c9296bfa8a0" args="(void)" -->
......
91 98
          <td class="paramtype">void&nbsp;</td>
92 99
          <td class="paramname">          </td>
93 100
          <td>&nbsp;)&nbsp;</td>
94
          <td width="100%"></td>
101
          <td></td>
95 102
        </tr>
96 103
      </table>
97 104
</div>
......
103 110
Unregister this packet group with the wireless library. This function must be called after wl_error_register.<p>
104 111
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__wlerror.html#g3217351e71b892a90ed3ba79ed36e354" title="Register this packet group with the wireless library.">wl_error_register</a> </dd></dl>
105 112

  
113
<p>References <a class="el" href="wireless_8c_source.html#l00362">wl_unregister_packet_group()</a>.</p>
114

  
106 115
</div>
107 116
</div><p>
108
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Apr 28 17:49:53 2008 for libwireless by&nbsp;
117
</div>
118
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Sep 4 13:14:45 2009 for libwireless by&nbsp;
109 119
<a href="http://www.doxygen.org/index.html">
110
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
120
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
111 121
</body>
112 122
</html>

Also available in: Unified diff