This file is indexed.

/usr/share/doc/libucommon-dev/a00160.html is in libucommon-doc 3.2.0-0ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>UCommon: ucc::StringFormat Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&nbsp;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>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&nbsp;Structure&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Data&nbsp;Fields</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00160.html">StringFormat</a>
  </div>
</div>
<div class="contents">
<h1>ucc::StringFormat Class Reference</h1><!-- doxytag: class="ucc::StringFormat" -->
<p>A string conversion class for use as a base class in objects which can transform themselves into string representations.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="a00207_source.html">string.h</a>&gt;</code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a5837a62407eee7944b7994852120340c">getStringSize</a> (void) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get maximum space that might be needed for string representation.  <a href="#a5837a62407eee7944b7994852120340c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00160.html#a0988d7b6a1a3afe5f213e9a1e0dda292">put</a> (char *buffer, size_t size) const =0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert derived object into a string buffer.  <a href="#a0988d7b6a1a3afe5f213e9a1e0dda292"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aaa783d013745e88510b2f8b121172f12"></a><!-- doxytag: member="ucc::StringFormat::string" ref="aaa783d013745e88510b2f8b121172f12" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>string</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2327fd9b02f5ab4c5ae842c54c950ffe"></a><!-- doxytag: member="ucc::StringFormat::string::cstring" ref="a2327fd9b02f5ab4c5ae842c54c950ffe" args="" -->
class&nbsp;</td><td class="memItemRight" valign="bottom"><b>string::cstring</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A string conversion class for use as a base class in objects which can transform themselves into string representations. </p>
<p>This can be used together with the string class for automatic conversions. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar &lt;<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="a00207_source.html#l01491">1491</a> of file <a class="el" href="a00207_source.html">string.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5837a62407eee7944b7994852120340c"></a><!-- doxytag: member="ucc::StringFormat::getStringSize" ref="a5837a62407eee7944b7994852120340c" args="(void) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00214.html#ab147df0377723db28a0d3ec1f419f2da">strsize_t</a> ucc::StringFormat::getStringSize </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get maximum space that might be needed for string representation. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>space needed. </dd></dl>

</div>
</div>
<a class="anchor" id="a0988d7b6a1a3afe5f213e9a1e0dda292"></a><!-- doxytag: member="ucc::StringFormat::put" ref="a0988d7b6a1a3afe5f213e9a1e0dda292" args="(char *buffer, size_t size) const =0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ucc::StringFormat::put </td>
          <td>(</td>
          <td class="paramtype">char *&nbsp;</td>
          <td class="paramname"> <em>buffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Convert derived object into a string buffer. </p>
<p>This may be a public method in a derived class. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>buffer</em>&nbsp;</td><td>to save representation in. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>of buffer to use. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00207_source.html">string.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:51 2010 for UCommon by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>