Symbian3/Examples/guid-6013a680-57f9-415b-8851-c4fa63356636/class_t_my_class.html
Addition of the PDK content and example code for Documentation_content according to Feature bug 1607 and bug 1608
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>TB10.1 Example Applications: TMyClass Class Reference</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.5.3 -->
<h1>TMyClass Class Reference</h1><!-- doxytag: class="TMyClass" -->
<p>
<a href="class_t_my_class-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#0cd85e121a9381570a6e661822e7f328">TMyClass</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#3e3f5a602a8be6eca1be2e6bc9287145">TMyClass</a> (const TDesC &aDes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#ca6375111d2a8a4f8ee068e2d882ff40">SetBuf</a> (const TDesC &aDes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const TDesC & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_t_my_class.html#748ac22426e7695ccfb1af1dd88c96a9">GetBuf</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Demonstrates a simple class containing a simple buffer and methods<ul>
<li>create a text buffer using new value</li><li>to set value to buffer</li><li>retrieve buffer's value </li></ul>
<p>Definition at line <a class="el" href="circularbuffer_8h-source.html#l00058">58</a> of file <a class="el" href="circularbuffer_8h-source.html">circularbuffer.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0cd85e121a9381570a6e661822e7f328"></a><!-- doxytag: member="TMyClass::TMyClass" ref="0cd85e121a9381570a6e661822e7f328" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TMyClass::TMyClass </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>Definition at line <a class="el" href="circularbuffer_8cpp-source.html#l00036">36</a> of file <a class="el" href="circularbuffer_8cpp-source.html">circularbuffer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="3e3f5a602a8be6eca1be2e6bc9287145"></a><!-- doxytag: member="TMyClass::TMyClass" ref="3e3f5a602a8be6eca1be2e6bc9287145" args="(const TDesC &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TMyClass::TMyClass </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aDes</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor. This overload <a class="el" href="class_t_my_class.html">TMyClass</a> constructor using a descriptor
<p>Definition at line <a class="el" href="circularbuffer_8cpp-source.html#l00040">40</a> of file <a class="el" href="circularbuffer_8cpp-source.html">circularbuffer.cpp</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ca6375111d2a8a4f8ee068e2d882ff40"></a><!-- doxytag: member="TMyClass::SetBuf" ref="ca6375111d2a8a4f8ee068e2d882ff40" args="(const TDesC &aDes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void TMyClass::SetBuf </td>
<td>(</td>
<td class="paramtype">const TDesC & </td>
<td class="paramname"> <em>aDes</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set <a class="el" href="class_t_my_class.html">TMyClass</a> buffer using a descriptor. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>aDes</em> </td><td>contains the new value for buffer. </td></tr>
</table>
</dl>
<p>Definition at line <a class="el" href="circularbuffer_8cpp-source.html#l00056">56</a> of file <a class="el" href="circularbuffer_8cpp-source.html">circularbuffer.cpp</a>.</p>
</div>
</div><p>
<a class="anchor" name="748ac22426e7695ccfb1af1dd88c96a9"></a><!-- doxytag: member="TMyClass::GetBuf" ref="748ac22426e7695ccfb1af1dd88c96a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const TDesC & TMyClass::GetBuf </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get <a class="el" href="class_t_my_class.html">TMyClass</a> buffers. <dl class="return" compact><dt><b>Returns:</b></dt><dd>A buffer contains the objects. </dd></dl>
<p>Definition at line <a class="el" href="circularbuffer_8cpp-source.html#l00048">48</a> of file <a class="el" href="circularbuffer_8cpp-source.html">circularbuffer.cpp</a>.</p>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Thu Jan 21 10:33:08 2010 for TB10.1 Example Applications by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
</body>
</html>