diff options
author | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-14 19:17:41 +0000 |
---|---|---|
committer | brain <brain@e03df62e-2008-0410-955e-edbf42e46eb7> | 2005-12-14 19:17:41 +0000 |
commit | a96514c284514116300794696f062c7fa6b1f79f (patch) | |
tree | b7b26583dcf354313f74613e604bd9c5dbb52acb /docs/module-doc/classRequest.html | |
parent | c4a345fe9903643a716ebf4c1df35fe28036bf4d (diff) |
Added new docs for class InspIRCd and globals.h etc
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@2451 e03df62e-2008-0410-955e-edbf42e46eb7
Diffstat (limited to 'docs/module-doc/classRequest.html')
-rw-r--r-- | docs/module-doc/classRequest.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/docs/module-doc/classRequest.html b/docs/module-doc/classRequest.html index bab6382ae..2ccfadc1e 100644 --- a/docs/module-doc/classRequest.html +++ b/docs/module-doc/classRequest.html @@ -102,7 +102,7 @@ Create a new Request. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00173">173</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00173"></a>00173 : <a class="code" href="classRequest.html#data">data</a>(anydata), <a class="code" href="classRequest.html#source">source</a>(src), <a class="code" href="classRequest.html#dest">dest</a>(dst) { }; +Definition at line <a class="el" href="modules_8cpp-source.html#l00165">165</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>.<div class="fragment"><pre class="fragment"><a name="l00165"></a>00165 : <a class="code" href="classRequest.html#data">data</a>(anydata), <a class="code" href="classRequest.html#source">source</a>(src), <a class="code" href="classRequest.html#dest">dest</a>(dst) { }; </pre></div> <p> </td> @@ -137,11 +137,11 @@ Fetch the Request data. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00175">175</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00167">167</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00162">data</a>.<div class="fragment"><pre class="fragment"><a name="l00176"></a>00176 { -<a name="l00177"></a>00177 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#data">data</a>; -<a name="l00178"></a>00178 } +References <a class="el" href="modules_8h-source.html#l00162">data</a>.<div class="fragment"><pre class="fragment"><a name="l00168"></a>00168 { +<a name="l00169"></a>00169 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#data">data</a>; +<a name="l00170"></a>00170 } </pre></div> <p> </td> @@ -175,11 +175,11 @@ Fetch the request destination (should be 'this' in the receiving module). <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00185">185</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00177">177</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00169">dest</a>.<div class="fragment"><pre class="fragment"><a name="l00186"></a>00186 { -<a name="l00187"></a>00187 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#dest">dest</a>; -<a name="l00188"></a>00188 } +References <a class="el" href="modules_8h-source.html#l00169">dest</a>.<div class="fragment"><pre class="fragment"><a name="l00178"></a>00178 { +<a name="l00179"></a>00179 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#dest">dest</a>; +<a name="l00180"></a>00180 } </pre></div> <p> </td> @@ -213,11 +213,11 @@ Fetch the request source. <p> <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00180">180</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +Definition at line <a class="el" href="modules_8cpp-source.html#l00172">172</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. <p> -References <a class="el" href="modules_8h-source.html#l00166">source</a>.<div class="fragment"><pre class="fragment"><a name="l00181"></a>00181 { -<a name="l00182"></a>00182 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#source">source</a>; -<a name="l00183"></a>00183 } +References <a class="el" href="modules_8h-source.html#l00166">source</a>.<div class="fragment"><pre class="fragment"><a name="l00173"></a>00173 { +<a name="l00174"></a>00174 <span class="keywordflow">return</span> this-><a class="code" href="classRequest.html#source">source</a>; +<a name="l00175"></a>00175 } </pre></div> <p> </td> @@ -253,18 +253,18 @@ Upon returning the result will be arbitary data returned by the module you sent <p> Implements <a class="el" href="classModuleMessage.html#Send_28_29_3D_30">ModuleMessage</a>. <p> -Definition at line <a class="el" href="modules_8cpp-source.html#l00190">190</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. -<p> -References <a class="el" href="modules_8h-source.html#l00169">dest</a>, and <a class="el" href="modules_8cpp-source.html#l00271">Module::OnRequest()</a>.<div class="fragment"><pre class="fragment"><a name="l00191"></a>00191 { -<a name="l00192"></a>00192 <span class="keywordflow">if</span> (this->dest) -<a name="l00193"></a>00193 { -<a name="l00194"></a>00194 <span class="keywordflow">return</span> <a class="code" href="classRequest.html#dest">dest</a>-><a class="code" href="classModule.html#OnRequest_28Request_20_2Arequest_29">OnRequest</a>(<span class="keyword">this</span>); -<a name="l00195"></a>00195 } -<a name="l00196"></a>00196 <span class="keywordflow">else</span> -<a name="l00197"></a>00197 { -<a name="l00198"></a>00198 <span class="keywordflow">return</span> NULL; -<a name="l00199"></a>00199 } -<a name="l00200"></a>00200 } +Definition at line <a class="el" href="modules_8cpp-source.html#l00182">182</a> of file <a class="el" href="modules_8cpp-source.html">modules.cpp</a>. +<p> +References <a class="el" href="modules_8h-source.html#l00169">dest</a>, and <a class="el" href="modules_8cpp-source.html#l00263">Module::OnRequest()</a>.<div class="fragment"><pre class="fragment"><a name="l00183"></a>00183 { +<a name="l00184"></a>00184 <span class="keywordflow">if</span> (this->dest) +<a name="l00185"></a>00185 { +<a name="l00186"></a>00186 <span class="keywordflow">return</span> <a class="code" href="classRequest.html#dest">dest</a>-><a class="code" href="classModule.html#OnRequest_28Request_20_2Arequest_29">OnRequest</a>(<span class="keyword">this</span>); +<a name="l00187"></a>00187 } +<a name="l00188"></a>00188 <span class="keywordflow">else</span> +<a name="l00189"></a>00189 { +<a name="l00190"></a>00190 <span class="keywordflow">return</span> NULL; +<a name="l00191"></a>00191 } +<a name="l00192"></a>00192 } </pre></div> <p> </td> @@ -297,7 +297,7 @@ This member holds a pointer to arbitary data set by the emitter of the message. <p> Definition at line <a class="el" href="modules_8h-source.html#l00162">162</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00175">GetData()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00167">GetData()</a>. </td> </tr> </table> <a class="anchor" name="dest"></a><!-- doxytag: member="Request::dest" ref="dest" args="" --><p> @@ -326,7 +326,7 @@ The single destination of the Request. <p> Definition at line <a class="el" href="modules_8h-source.html#l00169">169</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00185">GetDest()</a>, and <a class="el" href="modules_8cpp-source.html#l00190">Send()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00177">GetDest()</a>, and <a class="el" href="modules_8cpp-source.html#l00182">Send()</a>. </td> </tr> </table> <a class="anchor" name="source"></a><!-- doxytag: member="Request::source" ref="source" args="" --><p> @@ -355,12 +355,12 @@ This is a pointer to the sender of the message, which can be used to directly tr <p> Definition at line <a class="el" href="modules_8h-source.html#l00166">166</a> of file <a class="el" href="modules_8h-source.html">modules.h</a>. <p> -Referenced by <a class="el" href="modules_8cpp-source.html#l00180">GetSource()</a>. </td> +Referenced by <a class="el" href="modules_8cpp-source.html#l00172">GetSource()</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following files:<ul> <li><a class="el" href="modules_8h-source.html">modules.h</a><li><a class="el" href="modules_8cpp-source.html">modules.cpp</a></ul> -<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 14 15:55:50 2005 for InspIRCd by +<hr size="1"><address style="align: right;"><small>Generated on Wed Dec 14 19:16:27 2005 for InspIRCd by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4-20050815 </small></address> </body> |