This file is indexed.

/usr/share/gtk-doc/html/libanjuta/libanjuta-AnjutaAsyncCommand.html is in libanjuta-dev 2:3.4.0-1.

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
170
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AnjutaAsyncCommand</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Anjuta Developers Reference Manual">
<link rel="up" href="libanjuta-api.html" title="libanjuta API">
<link rel="prev" href="libanjuta-AnjutaSyncCommand.html" title="AnjutaSyncCommand">
<link rel="next" href="libanjuta-AnjutaVcsStatusTreeView.html" title="AnjutaVcsStatusTreeView">
<meta name="generator" content="GTK-Doc V1.18 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libanjuta-AnjutaSyncCommand.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libanjuta-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Anjuta Developers Reference Manual</th>
<td><a accesskey="n" href="libanjuta-AnjutaVcsStatusTreeView.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libanjuta-AnjutaAsyncCommand.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libanjuta-AnjutaAsyncCommand.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libanjuta-AnjutaAsyncCommand"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libanjuta-AnjutaAsyncCommand.top_of_page"></a>AnjutaAsyncCommand</span></h2>
<p>AnjutaAsyncCommand — <span class="type">AnjutaCommand</span> subclass that serves as the base for 
				   commands that need to run in another thread.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libanjuta-AnjutaAsyncCommand.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;libanjuta/anjuta-async-command.h&gt;

struct              <a class="link" href="libanjuta-AnjutaAsyncCommand.html#AnjutaAsyncCommandClass" title="struct AnjutaAsyncCommandClass">AnjutaAsyncCommandClass</a>;
                    <a class="link" href="libanjuta-AnjutaAsyncCommand.html#AnjutaAsyncCommandPriv" title="AnjutaAsyncCommandPriv">AnjutaAsyncCommandPriv</a>;
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             <a class="link" href="libanjuta-AnjutaAsyncCommand.html#anjuta-async-command-get-error-message" title="anjuta_async_command_get_error_message ()">anjuta_async_command_get_error_message</a>
                                                        (<em class="parameter"><code><span class="type">AnjutaCommand</span> *command</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libanjuta-AnjutaAsyncCommand.html#anjuta-async-command-lock" title="anjuta_async_command_lock ()">anjuta_async_command_lock</a>           (<em class="parameter"><code><span class="type">AnjutaAsyncCommand</span> *self</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libanjuta-AnjutaAsyncCommand.html#anjuta-async-command-set-error-message" title="anjuta_async_command_set_error_message ()">anjuta_async_command_set_error_message</a>
                                                        (<em class="parameter"><code><span class="type">AnjutaCommand</span> *command</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_message</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libanjuta-AnjutaAsyncCommand.html#anjuta-async-command-unlock" title="anjuta_async_command_unlock ()">anjuta_async_command_unlock</a>         (<em class="parameter"><code><span class="type">AnjutaAsyncCommand</span> *self</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libanjuta-AnjutaAsyncCommand.description"></a><h2>Description</h2>
<p>
<span class="type">AnjutaAsyncCommand</span> provides a simple way for plugins to run tasks that 
are synchronous and usually take several seconds or longer to execute in 
another thread so that such tasks do no block Anjuta's user interface.
</p>
<p>
<span class="type">AnjutaAsyncCommand</span> automatically runs and manages the thread when the 
command starts, and destroys it when the command finishes. Aside from 
locking protected data with anjuta_async_command_lock/unlock, clients, and
even commands themselves need not even be concerned that their tasks are 
rnning on another thread.
</p>
<p>
For an example of how <span class="type">AnjutaAsyncCommand</span> is used, see the Subversion plugin.
</p>
</div>
<div class="refsect1">
<a name="libanjuta-AnjutaAsyncCommand.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AnjutaAsyncCommandClass"></a><h3>struct AnjutaAsyncCommandClass</h3>
<pre class="programlisting">struct AnjutaAsyncCommandClass {
	AnjutaCommandClass parent_class;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="AnjutaAsyncCommandPriv"></a><h3>AnjutaAsyncCommandPriv</h3>
<pre class="programlisting">typedef struct _AnjutaAsyncCommandPriv AnjutaAsyncCommandPriv;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-command-get-error-message"></a><h3>anjuta_async_command_get_error_message ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *             anjuta_async_command_get_error_message
                                                        (<em class="parameter"><code><span class="type">AnjutaCommand</span> *command</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>command</code></em> :</span></p></td>
<td>AnjutaAsyncCommand object</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The error message the async command resulted in. The caller
should free the string</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-command-lock"></a><h3>anjuta_async_command_lock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                anjuta_async_command_lock           (<em class="parameter"><code><span class="type">AnjutaAsyncCommand</span> *self</code></em>);</pre>
<p>
Locks the command's built-in mutex.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>AnjutaAsyncCommand object.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-command-set-error-message"></a><h3>anjuta_async_command_set_error_message ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                anjuta_async_command_set_error_message
                                                        (<em class="parameter"><code><span class="type">AnjutaCommand</span> *command</code></em>,
                                                         <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *error_message</code></em>);</pre>
<p>
Set the error message this async command resulted in
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>command</code></em> :</span></p></td>
<td>AnjutaAsyncCommand object</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error_message</code></em> :</span></p></td>
<td>The error message that should be used</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="anjuta-async-command-unlock"></a><h3>anjuta_async_command_unlock ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                anjuta_async_command_unlock         (<em class="parameter"><code><span class="type">AnjutaAsyncCommand</span> *self</code></em>);</pre>
<p>
Unlocks the command's built-in mutex.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>AnjutaAsyncCommand object.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>