This file is indexed.

/usr/share/gtk-doc/html/libgwyddion/libgwyddion-gwyentities.html is in libgwyddion20-doc 2.34-3ubuntu1.

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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Library Reference Manual: gwyentities</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="up" href="index.html" title="Gwyddion Library Reference Manual">
<link rel="prev" href="libgwyddion-gwyddion.html" title="gwyddion">
<link rel="next" href="libgwyddion-Math.html" title="Math">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
                   | 
                  <a href="#libgwyddion-gwyentities.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><img src="up-insensitive.png" width="16" height="16" border="0"></td>
<td><a accesskey="p" href="libgwyddion-gwyddion.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libgwyddion-Math.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libgwyddion-gwyentities"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgwyddion-gwyentities.top_of_page"></a>gwyentities</span></h2>
<p>gwyentities — Transform SGML-like symbol entities to UTF-8</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libgwyddion-gwyentities.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libgwyddion/gwyddion.h&gt;

                    <a class="link" href="libgwyddion-gwyentities.html#GwyTextEntity" title="GwyTextEntity">GwyTextEntity</a>;
<a class="link" href="GwyInventory.html" title="GwyInventory"><span class="returnvalue">GwyInventory</span></a> *      <a class="link" href="libgwyddion-gwyentities.html#gwy-entities" title="gwy_entities ()">gwy_entities</a>                        (<em class="parameter"><code><span class="type">void</span></code></em>);
const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       <a class="link" href="libgwyddion-gwyentities.html#gwy-entities-entity-to-utf8" title="gwy_entities_entity_to_utf8 ()">gwy_entities_entity_to_utf8</a>         (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *entity</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libgwyddion-gwyentities.html#gwy-entities-text-to-utf8" title="gwy_entities_text_to_utf8 ()">gwy_entities_text_to_utf8</a>           (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libgwyddion-gwyentities.description"></a><h2>Description</h2>
<p>
A subset of named SGML-like symbol entities (e.g.
<code class="literal">&amp;alpha;</code>), to be used namely in <a href="../libgwydgets/GwySciText.html"><span class="type">GwySciText</span></a>.
</p>
<p>
Function <a class="link" href="libgwyddion-gwyentities.html#gwy-entities-entity-to-utf8" title="gwy_entities_entity_to_utf8 ()"><code class="function">gwy_entities_entity_to_utf8()</code></a> converts a signle entity to UTF-8.
Function <a class="link" href="libgwyddion-gwyentities.html#gwy-entities-text-to-utf8" title="gwy_entities_text_to_utf8 ()"><code class="function">gwy_entities_text_to_utf8()</code></a> converts a text containing entities to
UTF-8. An <a class="link" href="GwyInventory.html" title="GwyInventory"><span class="type">GwyInventory</span></a> with all available entities can be obtained with
<a class="link" href="libgwyddion-gwyentities.html#gwy-entities" title="gwy_entities ()"><code class="function">gwy_entities()</code></a>.
</p>
</div>
<div class="refsect1">
<a name="libgwyddion-gwyentities.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwyTextEntity"></a><h3>GwyTextEntity</h3>
<pre class="programlisting">typedef struct {
    const gchar *entity;
    const gchar *utf8;
} GwyTextEntity;
</pre>
<p>
The type of text entity data.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextEntity.entity"></a>entity</code></em>;</span></p></td>
<td>Bare entity name, without the leading ampersand and trailing
semicolon.</td>
</tr>
<tr>
<td><p><span class="term">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *<em class="structfield"><code><a name="GwyTextEntity.utf8"></a>utf8</code></em>;</span></p></td>
<td>The corresponding character, in UTF-8.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-entities"></a><h3>gwy_entities ()</h3>
<pre class="programlisting"><a class="link" href="GwyInventory.html" title="GwyInventory"><span class="returnvalue">GwyInventory</span></a> *      gwy_entities                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a constant inventory with all available entities.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The entities as a <a class="link" href="GwyInventory.html" title="GwyInventory"><span class="type">GwyInventory</span></a>.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-entities-entity-to-utf8"></a><h3>gwy_entities_entity_to_utf8 ()</h3>
<pre class="programlisting">const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *       gwy_entities_entity_to_utf8         (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *entity</code></em>);</pre>
<p>
Converts a single named entity <em class="parameter"><code>entity</code></em> to UTF-8 representation.
</p>
<p>
The string passed to this function should be a bare entity name, i.e. it
should not contain the ampersand and semicolon.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>entity</code></em> :</span></p></td>
<td>A single entity name, as a nul-delimited string.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<em class="parameter"><code>entity</code></em> if the name was not recognized, or a valid UTF-8 string.
If the returned string is not equal to <em class="parameter"><code>entities</code></em>, it's owned by
entities and must not be freed nor modified.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-entities-text-to-utf8"></a><h3>gwy_entities_text_to_utf8 ()</h3>
<pre class="programlisting"><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             gwy_entities_text_to_utf8           (<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<p>
Converts entities in a text to UTF-8.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>A nul-delimited string.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly allocated nul-delimited string containing the converted
text.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19</div>
</body>
</html>