Merge lp:~3v1n0/libappindicator/g-ir-scanner-docs into lp:libappindicator
- g-ir-scanner-docs
- Merge into trunk
Status: | Merged |
---|---|
Approved by: | Ted Gould |
Approved revision: | 219 |
Merged at revision: | 213 |
Proposed branch: | lp:~3v1n0/libappindicator/g-ir-scanner-docs |
Merge into: | lp:libappindicator |
Prerequisite: | lp:~3v1n0/libappindicator/secondary-activate-support |
Diff against target: |
1387 lines (+490/-492) 3 files modified
src/Makefile.am (+1/-0) src/app-indicator.c (+350/-353) src/app-indicator.h (+139/-139) |
To merge this branch: | bzr merge lp:~3v1n0/libappindicator/g-ir-scanner-docs |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Ted Gould (community) | Approve | ||
Review via email: mp+68560@code.launchpad.net |
Commit message
Description of the change
When compiling libappindicator you get some g-ir-scanner warnings:
GISCAN AppIndicator3-
app-indicator.
app-indicator.
This is due to the fact that the app-indicator.c is not scanned and the comments there don't use a syntax that the scanner recognize... This branch fixes this issue, moving all the GTK-doc comments to the standard syntax.
PS: As important side-effect of this warning, the mentioned functions aren't (were not) available in gir based bindings such as Vala.
Marco Trevisan (Treviño) (3v1n0) wrote : | # |
Eh, unfortunately that's the only format that it seems to recognize, but to get nice bindings with low effort this is the way to write comments! :)
Preview Diff
1 | === modified file 'src/Makefile.am' |
2 | --- src/Makefile.am 2011-02-11 04:04:25 +0000 |
3 | +++ src/Makefile.am 2011-07-20 15:29:24 +0000 |
4 | @@ -148,6 +148,7 @@ |
5 | if HAVE_INTROSPECTION |
6 | |
7 | introspection_sources = \ |
8 | + $(addprefix $(srcdir)/,app-indicator.c) \ |
9 | $(addprefix $(srcdir)/,$(libappindicator_headers)) |
10 | |
11 | AppIndicator$(VER)-0.1.gir: libappindicator$(VER).la |
12 | |
13 | === modified file 'src/app-indicator.c' |
14 | --- src/app-indicator.c 2011-07-20 15:29:24 +0000 |
15 | +++ src/app-indicator.c 2011-07-20 15:29:24 +0000 |
16 | @@ -51,20 +51,18 @@ |
17 | #define PANEL_ICON_SUFFIX "panel" |
18 | |
19 | /** |
20 | - AppIndicatorPrivate: |
21 | - |
22 | - All of the private data in an instance of a |
23 | - application indicator. |
24 | -*/ |
25 | -/* Private Fields |
26 | - @id: The ID of the indicator. Maps to AppIndicator:id. |
27 | - @category: Which category the indicator is. Maps to AppIndicator:category. |
28 | - @status: The status of the indicator. Maps to AppIndicator:status. |
29 | - @icon_name: The name of the icon to use. Maps to AppIndicator:icon-name. |
30 | - @attention_icon_name: The name of the attention icon to use. Maps to AppIndicator:attention-icon-name. |
31 | - @menu: The menu for this indicator. Maps to AppIndicator:menu |
32 | - @watcher_proxy: The proxy connection to the watcher we're connected to. If we're not connected to one this will be %NULL. |
33 | -*/ |
34 | + * AppIndicatorPrivate: |
35 | + * All of the private data in an instance of an application indicator. |
36 | + * |
37 | + * Private Fields |
38 | + * @id: The ID of the indicator. Maps to AppIndicator:id. |
39 | + * @category: Which category the indicator is. Maps to AppIndicator:category. |
40 | + * @status: The status of the indicator. Maps to AppIndicator:status. |
41 | + * @icon_name: The name of the icon to use. Maps to AppIndicator:icon-name. |
42 | + * @attention_icon_name: The name of the attention icon to use. Maps to AppIndicator:attention-icon-name. |
43 | + * @menu: The menu for this indicator. Maps to AppIndicator:menu |
44 | + * @watcher_proxy: The proxy connection to the watcher we're connected to. If we're not connected to one this will be %NULL. |
45 | + */ |
46 | struct _AppIndicatorPrivate { |
47 | /*< Private >*/ |
48 | /* Properties */ |
49 | @@ -225,11 +223,11 @@ |
50 | /* Properties */ |
51 | |
52 | /** |
53 | - AppIndicator:id: |
54 | - |
55 | - The ID for this indicator, which should be unique, but used consistently |
56 | - by this program and its indicator. |
57 | - */ |
58 | + * AppIndicator:id: |
59 | + * |
60 | + * The ID for this indicator, which should be unique, but used consistently |
61 | + * by this program and its indicator. |
62 | + */ |
63 | g_object_class_install_property (object_class, |
64 | PROP_ID, |
65 | g_param_spec_string(PROP_ID_S, |
66 | @@ -239,11 +237,11 @@ |
67 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY)); |
68 | |
69 | /** |
70 | - AppIndicator:category: |
71 | - |
72 | - The type of indicator that this represents. Please don't use 'Other'. |
73 | - Defaults to 'ApplicationStatus'. |
74 | - */ |
75 | + * AppIndicator:category: |
76 | + * |
77 | + * The type of indicator that this represents. Please don't use 'Other'. |
78 | + * Defaults to 'ApplicationStatus'. |
79 | + */ |
80 | g_object_class_install_property (object_class, |
81 | PROP_CATEGORY, |
82 | g_param_spec_string (PROP_CATEGORY_S, |
83 | @@ -253,11 +251,11 @@ |
84 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY)); |
85 | |
86 | /** |
87 | - AppIndicator:status: |
88 | - |
89 | - Whether the indicator is shown or requests attention. Defaults to |
90 | - 'Passive'. |
91 | - */ |
92 | + * AppIndicator: |
93 | + * |
94 | + * Whether the indicator is shown or requests attention. Defaults to |
95 | + * 'Passive'. |
96 | + */ |
97 | g_object_class_install_property (object_class, |
98 | PROP_STATUS, |
99 | g_param_spec_string (PROP_STATUS_S, |
100 | @@ -267,10 +265,10 @@ |
101 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
102 | |
103 | /** |
104 | - AppIndicator:icon-name: |
105 | - |
106 | - The name of the regular icon that is shown for the indicator. |
107 | - */ |
108 | + * AppIndicator:icon-name: |
109 | + * |
110 | + * The name of the regular icon that is shown for the indicator. |
111 | + */ |
112 | g_object_class_install_property(object_class, |
113 | PROP_ICON_NAME, |
114 | g_param_spec_string (PROP_ICON_NAME_S, |
115 | @@ -279,10 +277,10 @@ |
116 | NULL, |
117 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
118 | /** |
119 | - AppIndicator:icon-desc: |
120 | - |
121 | - The description of the regular icon that is shown for the indicator. |
122 | - */ |
123 | + * AppIndicator:icon-desc: |
124 | + * |
125 | + * The description of the regular icon that is shown for the indicator. |
126 | + */ |
127 | g_object_class_install_property(object_class, |
128 | PROP_ICON_DESC, |
129 | g_param_spec_string (PROP_ICON_DESC_S, |
130 | @@ -292,11 +290,11 @@ |
131 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
132 | |
133 | /** |
134 | - AppIndicator:attention-icon-name: |
135 | - |
136 | - If the indicator sets it's status to %APP_INDICATOR_STATUS_ATTENTION |
137 | - then this icon is shown. |
138 | - */ |
139 | + * AppIndicator:attention-icon-name: |
140 | + * |
141 | + * If the indicator sets it's status to %APP_INDICATOR_STATUS_ATTENTION |
142 | + * then this icon is shown. |
143 | + */ |
144 | g_object_class_install_property (object_class, |
145 | PROP_ATTENTION_ICON_NAME, |
146 | g_param_spec_string (PROP_ATTENTION_ICON_NAME_S, |
147 | @@ -305,11 +303,11 @@ |
148 | NULL, |
149 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
150 | /** |
151 | - AppIndicator:attention-icon-desc: |
152 | - |
153 | - If the indicator sets it's status to %APP_INDICATOR_STATUS_ATTENTION |
154 | - then this textual description of the icon shown. |
155 | - */ |
156 | + * AppIndicator:attention-icon-desc: |
157 | + * |
158 | + * If the indicator sets it's status to %APP_INDICATOR_STATUS_ATTENTION |
159 | + * then this textual description of the icon shown. |
160 | + */ |
161 | g_object_class_install_property (object_class, |
162 | PROP_ATTENTION_ICON_DESC, |
163 | g_param_spec_string (PROP_ATTENTION_ICON_DESC_S, |
164 | @@ -318,11 +316,11 @@ |
165 | NULL, |
166 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
167 | /** |
168 | - AppIndicator:icon-theme-path: |
169 | - |
170 | - An additional place to look for icon names that may be installed by the |
171 | - application. |
172 | - */ |
173 | + * AppIndicator:icon-theme-path: |
174 | + * |
175 | + * An additional place to look for icon names that may be installed by the |
176 | + * application. |
177 | + */ |
178 | g_object_class_install_property(object_class, |
179 | PROP_ICON_THEME_PATH, |
180 | g_param_spec_string (PROP_ICON_THEME_PATH_S, |
181 | @@ -332,11 +330,11 @@ |
182 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT)); |
183 | |
184 | /** |
185 | - AppIndicator:connected: |
186 | - |
187 | - Pretty simple, %TRUE if we have a reasonable expectation of being |
188 | - displayed through this object. You should hide your TrayIcon if so. |
189 | - */ |
190 | + * AppIndicator:connected: |
191 | + * |
192 | + * Pretty simple, %TRUE if we have a reasonable expectation of being |
193 | + * displayed through this object. You should hide your TrayIcon if so. |
194 | + */ |
195 | g_object_class_install_property (object_class, |
196 | PROP_CONNECTED, |
197 | g_param_spec_boolean (PROP_CONNECTED_S, |
198 | @@ -345,15 +343,15 @@ |
199 | FALSE, |
200 | G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); |
201 | /** |
202 | - AppIndicator:label: |
203 | - |
204 | - A label that can be shown next to the string in the application |
205 | - indicator. The label will not be shown unless there is an icon |
206 | - as well. The label is useful for numerical and other frequently |
207 | - updated information. In general, it shouldn't be shown unless a |
208 | - user requests it as it can take up a significant amount of space |
209 | - on the user's panel. This may not be shown in all visualizations. |
210 | - */ |
211 | + * AppIndicator:label: |
212 | + * |
213 | + * A label that can be shown next to the string in the application |
214 | + * indicator. The label will not be shown unless there is an icon |
215 | + * as well. The label is useful for numerical and other frequently |
216 | + * updated information. In general, it shouldn't be shown unless a |
217 | + * user requests it as it can take up a significant amount of space |
218 | + * on the user's panel. This may not be shown in all visualizations. |
219 | + */ |
220 | g_object_class_install_property(object_class, |
221 | PROP_LABEL, |
222 | g_param_spec_string (PROP_LABEL_S, |
223 | @@ -362,16 +360,16 @@ |
224 | NULL, |
225 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
226 | /** |
227 | - AppIndicator:label-guide: |
228 | - |
229 | - An optional string to provide guidance to the panel on how big |
230 | - the #AppIndicator:label string could get. If this is set correctly |
231 | - then the panel should never 'jiggle' as the string adjusts through |
232 | - out the range of options. For instance, if you were providing a |
233 | - percentage like "54% thrust" in #AppIndicator:label you'd want to |
234 | - set this string to "100% thrust" to ensure space when Scotty can |
235 | - get you enough power. |
236 | - */ |
237 | + * AppIndicator:label-guide: |
238 | + * |
239 | + * An optional string to provide guidance to the panel on how big |
240 | + * the #AppIndicator:label string could get. If this is set correctly |
241 | + * then the panel should never 'jiggle' as the string adjusts through |
242 | + * out the range of options. For instance, if you were providing a |
243 | + * percentage like "54% thrust" in #AppIndicator:label you'd want to |
244 | + * set this string to "100% thrust" to ensure space when Scotty can |
245 | + * get you enough power. |
246 | + */ |
247 | g_object_class_install_property(object_class, |
248 | PROP_LABEL_GUIDE, |
249 | g_param_spec_string (PROP_LABEL_GUIDE_S, |
250 | @@ -380,17 +378,17 @@ |
251 | NULL, |
252 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
253 | /** |
254 | - AppIndicator:ordering-index: |
255 | - |
256 | - The ordering index is an odd parameter, and if you think you don't need |
257 | - it you're probably right. In general, the application indicator try |
258 | - to place the applications in a recreatable place taking into account |
259 | - which category they're in to try and group them. But, there are some |
260 | - cases where you'd want to ensure indicators are next to each other. |
261 | - To do that you can override the generated ordering index and replace it |
262 | - with a new one. Again, you probably don't want to be doing this, but |
263 | - in case you do, this is the way. |
264 | - */ |
265 | + * AppIndicator:ordering-index: |
266 | + * |
267 | + * The ordering index is an odd parameter, and if you think you don't need |
268 | + * it you're probably right. In general, the application indicator try |
269 | + * to place the applications in a recreatable place taking into account |
270 | + * which category they're in to try and group them. But, there are some |
271 | + * cases where you'd want to ensure indicators are next to each other. |
272 | + * To do that you can override the generated ordering index and replace it |
273 | + * with a new one. Again, you probably don't want to be doing this, but |
274 | + * in case you do, this is the way. |
275 | + */ |
276 | g_object_class_install_property(object_class, |
277 | PROP_ORDERING_INDEX, |
278 | g_param_spec_uint (PROP_ORDERING_INDEX_S, |
279 | @@ -400,11 +398,11 @@ |
280 | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); |
281 | |
282 | /** |
283 | - AppIndicator:dbus-menu-server: |
284 | - |
285 | - A way to get the internal dbusmenu server if it is available. |
286 | - This should only be used for testing. |
287 | - */ |
288 | + * AppIndicator:dbus-menu-server: |
289 | + * |
290 | + * A way to get the internal dbusmenu server if it is available. |
291 | + * This should only be used for testing. |
292 | + */ |
293 | g_object_class_install_property(object_class, |
294 | PROP_DBUS_MENU_SERVER, |
295 | g_param_spec_object (PROP_DBUS_MENU_SERVER_S, |
296 | @@ -416,11 +414,11 @@ |
297 | /* Signals */ |
298 | |
299 | /** |
300 | - AppIndicator::new-icon: |
301 | - @arg0: The #AppIndicator object |
302 | - |
303 | - Emitted when #AppIndicator:icon-name is changed |
304 | - */ |
305 | + * AppIndicator::new-icon: |
306 | + * @arg0: The #AppIndicator object |
307 | + * |
308 | + * when #AppIndicator:icon-name is changed |
309 | + */ |
310 | signals[NEW_ICON] = g_signal_new (APP_INDICATOR_SIGNAL_NEW_ICON, |
311 | G_TYPE_FROM_CLASS(klass), |
312 | G_SIGNAL_RUN_LAST, |
313 | @@ -430,11 +428,11 @@ |
314 | G_TYPE_NONE, 0, G_TYPE_NONE); |
315 | |
316 | /** |
317 | - AppIndicator::new-attention-icon: |
318 | - @arg0: The #AppIndicator object |
319 | - |
320 | - Emitted when #AppIndicator:attention-icon-name is changed |
321 | - */ |
322 | + * AppIndicator::new-attention-icon: |
323 | + * @arg0: The #AppIndicator object |
324 | + * |
325 | + * Emitted when #AppIndicator:attention-icon-name is changed |
326 | + */ |
327 | signals[NEW_ATTENTION_ICON] = g_signal_new (APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON, |
328 | G_TYPE_FROM_CLASS(klass), |
329 | G_SIGNAL_RUN_LAST, |
330 | @@ -444,12 +442,12 @@ |
331 | G_TYPE_NONE, 0, G_TYPE_NONE); |
332 | |
333 | /** |
334 | - AppIndicator::new-status: |
335 | - @arg0: The #AppIndicator object |
336 | - @arg1: The string value of the #AppIndicatorStatus enum. |
337 | - |
338 | - Emitted when #AppIndicator:status is changed |
339 | - */ |
340 | + * AppIndicator::new-status: |
341 | + * @arg0: The #AppIndicator object |
342 | + * @arg1: The string value of the #AppIndicatorStatus enum. |
343 | + * |
344 | + * Emitted when #AppIndicator:status is changed |
345 | + */ |
346 | signals[NEW_STATUS] = g_signal_new (APP_INDICATOR_SIGNAL_NEW_STATUS, |
347 | G_TYPE_FROM_CLASS(klass), |
348 | G_SIGNAL_RUN_LAST, |
349 | @@ -460,13 +458,13 @@ |
350 | G_TYPE_STRING); |
351 | |
352 | /** |
353 | - AppIndicator::new-label: |
354 | - @arg0: The #AppIndicator object |
355 | - @arg1: The string for the label |
356 | - @arg1: The string for the guide |
357 | - |
358 | - Emitted when either #AppIndicator:label or #AppIndicator:label-guide are |
359 | - changed. |
360 | + * AppIndicator::new-label: |
361 | + * @arg0: The #AppIndicator object |
362 | + * @arg1: The string for the label |
363 | + * @arg1: The string for the guide |
364 | + * |
365 | + * Emitted when either #AppIndicator:label or #AppIndicator:label-guide are |
366 | + * changed. |
367 | */ |
368 | signals[NEW_LABEL] = g_signal_new (APP_INDICATOR_SIGNAL_NEW_LABEL, |
369 | G_TYPE_FROM_CLASS(klass), |
370 | @@ -477,12 +475,12 @@ |
371 | G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_STRING); |
372 | |
373 | /** |
374 | - AppIndicator::connection-changed: |
375 | - @arg0: The #AppIndicator object |
376 | - @arg1: Whether we're connected or not |
377 | - |
378 | - Signaled when we connect to a watcher, or when it drops away. |
379 | - */ |
380 | + * AppIndicator::connection-changed: |
381 | + * @arg0: The #AppIndicator object |
382 | + * @arg1: Whether we're connected or not |
383 | + * |
384 | + * Signaled when we connect to a watcher, or when it drops away. |
385 | + */ |
386 | signals[CONNECTION_CHANGED] = g_signal_new (APP_INDICATOR_SIGNAL_CONNECTION_CHANGED, |
387 | G_TYPE_FROM_CLASS(klass), |
388 | G_SIGNAL_RUN_LAST, |
389 | @@ -492,12 +490,12 @@ |
390 | G_TYPE_NONE, 1, G_TYPE_BOOLEAN, G_TYPE_NONE); |
391 | |
392 | /** |
393 | - AppIndicator::new-icon-theme-path: |
394 | - @arg0: The #AppIndicator object |
395 | - |
396 | - Signaled when there is a new icon set for the |
397 | - object. |
398 | - */ |
399 | + * AppIndicator::new-icon-theme-path: |
400 | + * @arg0: The #AppIndicator object |
401 | + * |
402 | + * Signaled when there is a new icon set for the |
403 | + * object. |
404 | + */ |
405 | signals[NEW_ICON_THEME_PATH] = g_signal_new (APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH, |
406 | G_TYPE_FROM_CLASS(klass), |
407 | G_SIGNAL_RUN_LAST, |
408 | @@ -507,13 +505,13 @@ |
409 | G_TYPE_NONE, 1, G_TYPE_STRING); |
410 | |
411 | /** |
412 | - AppIndicator::scroll-event: |
413 | - @arg0: The #AppIndicator object |
414 | - @arg1: How many steps the scroll wheel has taken |
415 | - @arg2: (type Gdk.ScrollDirection) Which direction the wheel went in |
416 | - |
417 | - Signaled when the #AppIndicator receives a scroll event. |
418 | - */ |
419 | + * AppIndicator::scroll-event: |
420 | + * @arg0: The #AppIndicator object |
421 | + * @arg1: How many steps the scroll wheel has taken |
422 | + * @arg2: (type Gdk.ScrollDirection) Which direction the wheel went in |
423 | + * |
424 | + * Signaled when the #AppIndicator receives a scroll event. |
425 | + */ |
426 | signals[SCROLL_EVENT] = g_signal_new (APP_INDICATOR_SIGNAL_SCROLL_EVENT, |
427 | G_TYPE_FROM_CLASS(klass), |
428 | G_SIGNAL_RUN_LAST, |
429 | @@ -1646,17 +1644,16 @@ |
430 | /* ************************* */ |
431 | |
432 | /** |
433 | - app_indicator_new: |
434 | - @id: The unique id of the indicator to create. |
435 | - @icon_name: The icon name for this indicator |
436 | - @category: The category of indicator. |
437 | - |
438 | - Creates a new #AppIndicator setting the properties: |
439 | - #AppIndicator:id with @id, #AppIndicator:category |
440 | - with @category and #AppIndicator:icon-name with |
441 | - @icon_name. |
442 | - |
443 | - Return value: A pointer to a new #AppIndicator object. |
444 | + * app_indicator_new: |
445 | + * @id: The unique id of the indicator to create. |
446 | + * @icon_name: The icon name for this indicator |
447 | + * @category: The category of indicator. |
448 | + * |
449 | + * Creates a new #AppIndicator setting the properties: |
450 | + * #AppIndicator:id with @id, #AppIndicator:category with @category |
451 | + * and #AppIndicator:icon-name with @icon_name. |
452 | + * |
453 | + * Return value: A pointer to a new #AppIndicator object. |
454 | */ |
455 | AppIndicator * |
456 | app_indicator_new (const gchar *id, |
457 | @@ -1673,18 +1670,18 @@ |
458 | } |
459 | |
460 | /** |
461 | - app_indicator_new_with_path: |
462 | - @id: The unique id of the indicator to create. |
463 | - @icon_name: The icon name for this indicator |
464 | - @category: The category of indicator. |
465 | - @icon_theme_path: A custom path for finding icons. |
466 | - |
467 | - Creates a new #AppIndicator setting the properties: |
468 | - #AppIndicator:id with @id, #AppIndicator:category |
469 | - with @category, #AppIndicator:icon-name with |
470 | - @icon_name and #AppIndicator:icon-theme-path with @icon_theme_path. |
471 | - |
472 | - Return value: A pointer to a new #AppIndicator object. |
473 | + * app_indicator_new_with_path: |
474 | + * @id: The unique id of the indicator to create. |
475 | + * @icon_name: The icon name for this indicator |
476 | + * @category: The category of indicator. |
477 | + * @icon_theme_path: A custom path for finding icons. |
478 | + |
479 | + * Creates a new #AppIndicator setting the properties: |
480 | + * #AppIndicator:id with @id, #AppIndicator:category with @category, |
481 | + * #AppIndicator:icon-name with @icon_name and #AppIndicator:icon-theme-path |
482 | + * with @icon_theme_path. |
483 | + * |
484 | + * Return value: A pointer to a new #AppIndicator object. |
485 | */ |
486 | AppIndicator * |
487 | app_indicator_new_with_path (const gchar *id, |
488 | @@ -1703,20 +1700,20 @@ |
489 | } |
490 | |
491 | /** |
492 | - app_indicator_get_type: |
493 | - |
494 | - Generates or returns the unique #GType for #AppIndicator. |
495 | - |
496 | - Return value: A unique #GType for #AppIndicator objects. |
497 | -*/ |
498 | + * app_indicator_get_type: |
499 | + * |
500 | + * Generates or returns the unique #GType for #AppIndicator. |
501 | + * |
502 | + * Return value: A unique #GType for #AppIndicator objects. |
503 | + */ |
504 | |
505 | /** |
506 | - app_indicator_set_status: |
507 | - @self: The #AppIndicator object to use |
508 | - @status: The status to set for this indicator |
509 | - |
510 | - Wrapper function for property #AppIndicator:status. |
511 | -*/ |
512 | + * app_indicator_set_status: |
513 | + * @self: The #AppIndicator object to use |
514 | + * @status: The status to set for this indicator |
515 | + * |
516 | + * Wrapper function for property #AppIndicator:status. |
517 | + */ |
518 | void |
519 | app_indicator_set_status (AppIndicator *self, AppIndicatorStatus status) |
520 | { |
521 | @@ -1750,15 +1747,15 @@ |
522 | } |
523 | |
524 | /** |
525 | - app_indicator_set_attention_icon: |
526 | - @self: The #AppIndicator object to use |
527 | - @icon_name: The name of the attention icon to set for this indicator |
528 | - |
529 | - Wrapper for app_indicator_set_attention_icon_full() with a NULL |
530 | - description. |
531 | - |
532 | - Deprecated: Use app_indicator_set_attention_icon_full() instead. |
533 | -*/ |
534 | + * app_indicator_set_attention_icon: |
535 | + * @self: The #AppIndicator object to use |
536 | + * @icon_name: The name of the attention icon to set for this indicator |
537 | + * |
538 | + * Wrapper for app_indicator_set_attention_icon_full() with a NULL |
539 | + * description. |
540 | + * |
541 | + * Deprecated: Use app_indicator_set_attention_icon_full() instead. |
542 | + */ |
543 | void |
544 | app_indicator_set_attention_icon (AppIndicator *self, const gchar *icon_name) |
545 | { |
546 | @@ -1766,13 +1763,13 @@ |
547 | } |
548 | |
549 | /** |
550 | - app_indicator_set_attention_icon_full: |
551 | - @self: The #AppIndicator object to use |
552 | - @icon_name: The name of the attention icon to set for this indicator |
553 | - @icon_desc: A textual description of the icon |
554 | - |
555 | - Wrapper function for property #AppIndicator:attention-icon-name. |
556 | -*/ |
557 | + * app_indicator_set_attention_icon_full: |
558 | + * @self: The #AppIndicator object to use |
559 | + * @icon_name: The name of the attention icon to set for this indicator |
560 | + * @icon_desc: A textual description of the icon |
561 | + * |
562 | + * Wrapper function for property #AppIndicator:attention-icon-name. |
563 | + */ |
564 | void |
565 | app_indicator_set_attention_icon_full (AppIndicator *self, const gchar *icon_name, const gchar * icon_desc) |
566 | { |
567 | @@ -1823,15 +1820,15 @@ |
568 | } |
569 | |
570 | /** |
571 | - app_indicator_set_icon: |
572 | - @self: The #AppIndicator object to use |
573 | - @icon_name: The icon name to set. |
574 | - |
575 | - Wrapper function for app_indicator_set_icon_full() with a NULL |
576 | - description. |
577 | - |
578 | - Deprecated: Use app_indicator_set_icon_full() |
579 | -**/ |
580 | + * app_indicator_set_icon: |
581 | + * @self: The #AppIndicator object to use |
582 | + * @icon_name: The icon name to set. |
583 | + * |
584 | + * Wrapper function for app_indicator_set_icon_full() with a NULL |
585 | + * description. |
586 | + * |
587 | + * Deprecated: Use app_indicator_set_icon_full() |
588 | + */ |
589 | void |
590 | app_indicator_set_icon (AppIndicator *self, const gchar *icon_name) |
591 | { |
592 | @@ -1839,18 +1836,18 @@ |
593 | } |
594 | |
595 | /** |
596 | - app_indicator_set_icon_full: |
597 | - @self: The #AppIndicator object to use |
598 | - @icon_name: The icon name to set. |
599 | - @icon_desc: A textual description of the icon for accessibility |
600 | - |
601 | - Sets the default icon to use when the status is active but |
602 | - not set to attention. In most cases, this should be the |
603 | - application icon for the program. |
604 | - |
605 | - Wrapper function for property #AppIndicator:icon-name and |
606 | - #AppIndicator::icon-desc. |
607 | -**/ |
608 | + * app_indicator_set_icon_full: |
609 | + * @self: The #AppIndicator object to use |
610 | + * @icon_name: The icon name to set. |
611 | + * @icon_desc: A textual description of the icon for accessibility |
612 | + * |
613 | + * Sets the default icon to use when the status is active but |
614 | + * not set to attention. In most cases, this should be the |
615 | + * application icon for the program. |
616 | + * |
617 | + * Wrapper function for property #AppIndicator:icon-name and |
618 | + * #AppIndicator::icon-desc. |
619 | + */ |
620 | void |
621 | app_indicator_set_icon_full (AppIndicator *self, const gchar *icon_name, const gchar * icon_desc) |
622 | { |
623 | @@ -1901,14 +1898,14 @@ |
624 | } |
625 | |
626 | /** |
627 | - app_indicator_set_label: |
628 | - @self: The #AppIndicator object to use |
629 | - @label: The label to show next to the icon. |
630 | - @guide: A guide to size the label correctly. |
631 | - |
632 | - This is a wrapper function for the #AppIndicator:label and |
633 | - #AppIndicator:guide properties. This function can take #NULL |
634 | - as either @label or @guide and will clear the entries. |
635 | + * app_indicator_set_label: |
636 | + * @self: The #AppIndicator object to use |
637 | + * @label: The label to show next to the icon. |
638 | + * @guide: A guide to size the label correctly. |
639 | + * |
640 | + * This is a wrapper function for the #AppIndicator:label and |
641 | + * #AppIndicator:guide properties. This function can take #NULL |
642 | + * as either @label or @guide and will clear the entries. |
643 | */ |
644 | void |
645 | app_indicator_set_label (AppIndicator *self, const gchar * label, const gchar * guide) |
646 | @@ -1926,12 +1923,12 @@ |
647 | } |
648 | |
649 | /** |
650 | - app_indicator_set_icon_theme_path: |
651 | - @self: The #AppIndicator object to use |
652 | - @icon_theme_path: The icon theme path to set. |
653 | - |
654 | - Sets the path to use when searching for icons. |
655 | -**/ |
656 | + * app_indicator_set_icon_theme_path: |
657 | + * @self: The #AppIndicator object to use |
658 | + * @icon_theme_path: The icon theme path to set. |
659 | + * |
660 | + * Sets the path to use when searching for icons. |
661 | + */ |
662 | void |
663 | app_indicator_set_icon_theme_path (AppIndicator *self, const gchar *icon_theme_path) |
664 | { |
665 | @@ -1997,17 +1994,17 @@ |
666 | return; |
667 | } |
668 | |
669 | -/** |
670 | - app_indicator_set_menu: |
671 | - @self: The #AppIndicator |
672 | - @menu: A #GtkMenu to set |
673 | - |
674 | - Sets the menu that should be shown when the Application Indicator |
675 | - is clicked on in the panel. An application indicator will not |
676 | - be rendered unless it has a menu. |
677 | - |
678 | - Wrapper function for property #AppIndicator:menu. |
679 | -**/ |
680 | +/* |
681 | + * app_indicator_set_menu: |
682 | + * @self: The #AppIndicator |
683 | + * @menu: (allow-none): A #GtkMenu to set |
684 | + * |
685 | + * Sets the menu that should be shown when the Application Indicator |
686 | + * is clicked on in the panel. An application indicator will not |
687 | + * be rendered unless it has a menu. |
688 | + * |
689 | + * Wrapper function for property #AppIndicator:menu. |
690 | + */ |
691 | void |
692 | app_indicator_set_menu (AppIndicator *self, GtkMenu *menu) |
693 | { |
694 | @@ -2037,16 +2034,16 @@ |
695 | } |
696 | |
697 | /** |
698 | - app_indicator_set_ordering_index: |
699 | - @self: The #AppIndicator |
700 | - @ordering_index: A value for the ordering of this app indicator |
701 | - |
702 | - Sets the ordering index for the app indicator which effects the |
703 | - placement of it on the panel. For almost all app indicator |
704 | - this is not the function you're looking for. |
705 | - |
706 | - Wrapper function for property #AppIndicator:ordering-index. |
707 | -**/ |
708 | + * app_indicator_set_ordering_index: |
709 | + * @self: The #AppIndicator |
710 | + * @ordering_index: A value for the ordering of this app indicator |
711 | + * |
712 | + * Sets the ordering index for the app indicator which effects the |
713 | + * placement of it on the panel. For almost all app indicator |
714 | + * this is not the function you're looking for. |
715 | + * |
716 | + * Wrapper function for property #AppIndicator:ordering-index. |
717 | + */ |
718 | void |
719 | app_indicator_set_ordering_index (AppIndicator *self, guint32 ordering_index) |
720 | { |
721 | @@ -2058,19 +2055,19 @@ |
722 | } |
723 | |
724 | /** |
725 | - app_indicator_set_secondary_activate_target: |
726 | - @self: The #AppIndicator |
727 | - @menuitem: A #GtkWidget to be activated on secondary activation |
728 | - |
729 | - Set the @menuitem to be activated when a secondary activation event (i.e. a |
730 | - middle-click) is emitted over the #AppIndicator icon/label. |
731 | - |
732 | - The @menuitem can be also a complex #GtkWidget, but to get activated when |
733 | - a secondary activation occurs in the #Appindicator, it must be a visible and |
734 | - active child (or inner-child) of the #AppIndicator:menu. |
735 | - |
736 | - Setting @menuitem to %NULL causes to disable this feature. |
737 | -**/ |
738 | + * app_indicator_set_secondary_activate_target: |
739 | + * @self: The #AppIndicator |
740 | + * @menuitem: (allow-none): A #GtkWidget to be activated on secondary activation |
741 | + * |
742 | + * Set the @menuitem to be activated when a secondary activation event (i.e. a |
743 | + * middle-click) is emitted over the #AppIndicator icon/label. |
744 | + * |
745 | + * The @menuitem can be also a complex #GtkWidget, but to get activated when |
746 | + * a secondary activation occurs in the #Appindicator, it must be a visible and |
747 | + * active child (or inner-child) of the #AppIndicator:menu. |
748 | + * |
749 | + * Setting @menuitem to %NULL causes to disable this feature. |
750 | + */ |
751 | void |
752 | app_indicator_set_secondary_activate_target (AppIndicator *self, GtkWidget *menuitem) |
753 | { |
754 | @@ -2097,13 +2094,13 @@ |
755 | } |
756 | |
757 | /** |
758 | - app_indicator_get_id: |
759 | - @self: The #AppIndicator object to use |
760 | - |
761 | - Wrapper function for property #AppIndicator:id. |
762 | - |
763 | - Return value: The current ID |
764 | -*/ |
765 | + * app_indicator_get_id: |
766 | + * @self: The #AppIndicator object to use |
767 | + * |
768 | + * Wrapper function for property #AppIndicator:id. |
769 | + * |
770 | + * Return value: The current ID |
771 | + */ |
772 | const gchar * |
773 | app_indicator_get_id (AppIndicator *self) |
774 | { |
775 | @@ -2113,13 +2110,13 @@ |
776 | } |
777 | |
778 | /** |
779 | - app_indicator_get_category: |
780 | - @self: The #AppIndicator object to use |
781 | - |
782 | - Wrapper function for property #AppIndicator:category. |
783 | - |
784 | - Return value: The current category. |
785 | -*/ |
786 | + * app_indicator_get_category: |
787 | + * @self: The #AppIndicator object to use |
788 | + * |
789 | + * Wrapper function for property #AppIndicator:category. |
790 | + * |
791 | + * Return value: The current category. |
792 | + */ |
793 | AppIndicatorCategory |
794 | app_indicator_get_category (AppIndicator *self) |
795 | { |
796 | @@ -2129,13 +2126,13 @@ |
797 | } |
798 | |
799 | /** |
800 | - app_indicator_get_status: |
801 | - @self: The #AppIndicator object to use |
802 | - |
803 | - Wrapper function for property #AppIndicator:status. |
804 | - |
805 | - Return value: The current status. |
806 | -*/ |
807 | + * app_indicator_get_status: |
808 | + * @self: The #AppIndicator object to use |
809 | + * |
810 | + * Wrapper function for property #AppIndicator:status. |
811 | + * |
812 | + * Return value: The current status. |
813 | + */ |
814 | AppIndicatorStatus |
815 | app_indicator_get_status (AppIndicator *self) |
816 | { |
817 | @@ -2145,13 +2142,13 @@ |
818 | } |
819 | |
820 | /** |
821 | - app_indicator_get_icon: |
822 | - @self: The #AppIndicator object to use |
823 | - |
824 | - Wrapper function for property #AppIndicator:icon-name. |
825 | - |
826 | - Return value: The current icon name. |
827 | -*/ |
828 | + * app_indicator_get_icon: |
829 | + * @self: The #AppIndicator object to use |
830 | + * |
831 | + * Wrapper function for property #AppIndicator:icon-name. |
832 | + * |
833 | + * Return value: The current icon name. |
834 | + */ |
835 | const gchar * |
836 | app_indicator_get_icon (AppIndicator *self) |
837 | { |
838 | @@ -2161,12 +2158,12 @@ |
839 | } |
840 | |
841 | /** |
842 | - app_indicator_get_icon_desc: |
843 | - @self: The #AppIndicator object to use |
844 | - |
845 | - Wrapper function for property #AppIndicator:icon-desc. |
846 | - |
847 | - Return value: The current icon description. |
848 | + * app_indicator_get_icon_desc: |
849 | + * @self: The #AppIndicator object to use |
850 | + * |
851 | + * Wrapper function for property #AppIndicator:icon-desc. |
852 | + * |
853 | + * Return value: The current icon description. |
854 | */ |
855 | const gchar * |
856 | app_indicator_get_icon_desc (AppIndicator *self) |
857 | @@ -2177,13 +2174,13 @@ |
858 | } |
859 | |
860 | /** |
861 | - app_indicator_get_icon_theme_path: |
862 | - @self: The #AppIndicator object to use |
863 | - |
864 | - Wrapper function for property #AppIndicator:icon-theme-path. |
865 | - |
866 | - Return value: The current icon theme path. |
867 | -*/ |
868 | + * app_indicator_get_icon_theme_path: |
869 | + * @self: The #AppIndicator object to use |
870 | + * |
871 | + * Wrapper function for property #AppIndicator:icon-theme-path. |
872 | + * |
873 | + * Return value: The current icon theme path. |
874 | + */ |
875 | const gchar * |
876 | app_indicator_get_icon_theme_path (AppIndicator *self) |
877 | { |
878 | @@ -2193,13 +2190,13 @@ |
879 | } |
880 | |
881 | /** |
882 | - app_indicator_get_attention_icon: |
883 | - @self: The #AppIndicator object to use |
884 | - |
885 | - Wrapper function for property #AppIndicator:attention-icon-name. |
886 | - |
887 | - Return value: The current attention icon name. |
888 | -*/ |
889 | + * app_indicator_get_attention_icon: |
890 | + * @self: The #AppIndicator object to use |
891 | + * |
892 | + * Wrapper function for property #AppIndicator:attention-icon-name. |
893 | + * |
894 | + * Return value: The current attention icon name. |
895 | + */ |
896 | const gchar * |
897 | app_indicator_get_attention_icon (AppIndicator *self) |
898 | { |
899 | @@ -2209,13 +2206,13 @@ |
900 | } |
901 | |
902 | /** |
903 | - app_indicator_get_attention_icon_desc: |
904 | - @self: The #AppIndicator object to use |
905 | - |
906 | - Wrapper function for property #AppIndicator:attention-icon-desc. |
907 | - |
908 | - Return value: The current attention icon description. |
909 | -*/ |
910 | + * app_indicator_get_attention_icon_desc: |
911 | + * @self: The #AppIndicator object to use |
912 | + * |
913 | + * Wrapper function for property #AppIndicator:attention-icon-desc. |
914 | + * |
915 | + * Return value: The current attention icon description. |
916 | + */ |
917 | const gchar * |
918 | app_indicator_get_attention_icon_desc (AppIndicator *self) |
919 | { |
920 | @@ -2225,14 +2222,14 @@ |
921 | } |
922 | |
923 | /** |
924 | - app_indicator_get_menu: |
925 | - @self: The #AppIndicator object to use |
926 | - |
927 | - Gets the menu being used for this application indicator. |
928 | - Wrapper function for property #AppIndicator:menu. |
929 | - |
930 | - Return value: (transfer full): A #GtkMenu object or %NULL if one hasn't been set. |
931 | -*/ |
932 | + * app_indicator_get_menu: |
933 | + * @self: The #AppIndicator object to use |
934 | + * |
935 | + * Gets the menu being used for this application indicator. |
936 | + * Wrapper function for property #AppIndicator:menu. |
937 | + * |
938 | + * Returns: (transfer full): A #GtkMenu object or %NULL if one hasn't been set. |
939 | + */ |
940 | GtkMenu * |
941 | app_indicator_get_menu (AppIndicator *self) |
942 | { |
943 | @@ -2246,13 +2243,13 @@ |
944 | } |
945 | |
946 | /** |
947 | - app_indicator_get_label: |
948 | - @self: The #AppIndicator object to use |
949 | - |
950 | - Wrapper function for property #AppIndicator:label. |
951 | - |
952 | - Return value: The current label. |
953 | -*/ |
954 | + * app_indicator_get_label: |
955 | + * @self: The #AppIndicator object to use |
956 | + * |
957 | + * Wrapper function for property #AppIndicator:label. |
958 | + * |
959 | + * Return value: The current label. |
960 | + */ |
961 | const gchar * |
962 | app_indicator_get_label (AppIndicator *self) |
963 | { |
964 | @@ -2262,13 +2259,13 @@ |
965 | } |
966 | |
967 | /** |
968 | - app_indicator_get_label_guide: |
969 | - @self: The #AppIndicator object to use |
970 | - |
971 | - Wrapper function for property #AppIndicator:label-guide. |
972 | - |
973 | - Return value: The current label guide. |
974 | -*/ |
975 | + * app_indicator_get_label_guide: |
976 | + * @self: The #AppIndicator object to use |
977 | + * |
978 | + * Wrapper function for property #AppIndicator:label-guide. |
979 | + * |
980 | + * Return value: The current label guide. |
981 | + */ |
982 | const gchar * |
983 | app_indicator_get_label_guide (AppIndicator *self) |
984 | { |
985 | @@ -2278,13 +2275,13 @@ |
986 | } |
987 | |
988 | /** |
989 | - app_indicator_get_ordering_index: |
990 | - @self: The #AppIndicator object to use |
991 | - |
992 | - Wrapper function for property #AppIndicator:ordering-index. |
993 | - |
994 | - Return value: The current ordering index. |
995 | -*/ |
996 | + * app_indicator_get_ordering_index: |
997 | + * @self: The #AppIndicator object to use |
998 | + * |
999 | + * Wrapper function for property #AppIndicator:ordering-index. |
1000 | + * |
1001 | + * Return value: The current ordering index. |
1002 | + */ |
1003 | guint32 |
1004 | app_indicator_get_ordering_index (AppIndicator *self) |
1005 | { |
1006 | @@ -2298,13 +2295,13 @@ |
1007 | } |
1008 | |
1009 | /** |
1010 | - app_indicator_get_secondary_activate_target: |
1011 | - @self: The #AppIndicator object to use |
1012 | - |
1013 | - Gets the menuitem being called on secondary-activate event. |
1014 | - |
1015 | - Return value: (transfer full): A #GtkWidget object or %NULL if none has been set. |
1016 | -*/ |
1017 | + * app_indicator_get_secondary_activate_target: |
1018 | + * @self: The #AppIndicator object to use |
1019 | + * |
1020 | + * Gets the menuitem being called on secondary-activate event. |
1021 | + * |
1022 | + * Returns: (transfer full): A #GtkWidget object or %NULL if none has been set. |
1023 | + */ |
1024 | GtkWidget * |
1025 | app_indicator_get_secondary_activate_target (AppIndicator *self) |
1026 | { |
1027 | @@ -2335,14 +2332,14 @@ |
1028 | } |
1029 | |
1030 | /** |
1031 | - app_indicator_build_menu_from_desktop: |
1032 | - @self: The #AppIndicator object to use |
1033 | - @desktop_file: A path to the desktop file to build the menu from |
1034 | - @desktop_profile: Which entries should be used from the desktop file |
1035 | - |
1036 | - This function allows for building the Application Indicator menu |
1037 | - from a static desktop file. |
1038 | -*/ |
1039 | + * app_indicator_build_menu_from_desktop: |
1040 | + * @self: The #AppIndicator object to use |
1041 | + * @desktop_file: A path to the desktop file to build the menu from |
1042 | + * @desktop_profile: Which entries should be used from the desktop file |
1043 | + * |
1044 | + * This function allows for building the Application Indicator menu |
1045 | + * from a static desktop file. |
1046 | + */ |
1047 | void |
1048 | app_indicator_build_menu_from_desktop (AppIndicator * self, const gchar * desktop_file, const gchar * desktop_profile) |
1049 | { |
1050 | |
1051 | === modified file 'src/app-indicator.h' |
1052 | --- src/app-indicator.h 2011-07-20 15:29:24 +0000 |
1053 | +++ src/app-indicator.h 2011-07-20 15:29:24 +0000 |
1054 | @@ -35,40 +35,40 @@ |
1055 | G_BEGIN_DECLS |
1056 | |
1057 | /** |
1058 | - APP_INDICATOR_TYPE: |
1059 | - |
1060 | - Get the #GType for a #AppIndicator. |
1061 | -*/ |
1062 | -/** |
1063 | - APP_INDICATOR: |
1064 | - @obj: The object to convert |
1065 | - |
1066 | - Safely convert a #GObject into an #AppIndicator. |
1067 | -*/ |
1068 | -/** |
1069 | - APP_INDICATOR_CLASS: |
1070 | - @klass: #GObjectClass based class to convert. |
1071 | - |
1072 | - Safely convert a #GObjectClass into a #AppIndicatorClass. |
1073 | -*/ |
1074 | -/** |
1075 | - IS_APP_INDICATOR: |
1076 | - @obj: An #GObject to check |
1077 | - |
1078 | - Checks to see if @obj is in the object hierarchy of #AppIndicator. |
1079 | -*/ |
1080 | -/** |
1081 | - IS_APP_INDICATOR_CLASS: |
1082 | - @klass: An #GObjectClass to check |
1083 | - |
1084 | - Checks to see if @klass is in the object class hierarchy of #AppIndicatorClass. |
1085 | -*/ |
1086 | -/** |
1087 | - APP_INDICATOR_GET_CLASS: |
1088 | - @obj: A #GObject in the class hierarchy of #AppIndicator. |
1089 | - |
1090 | - Gets a pointer to the #AppIndicatorClass for the object @obj. |
1091 | -*/ |
1092 | + * APP_INDICATOR_TYPE: |
1093 | + * |
1094 | + * Get the #GType for a #AppIndicator. |
1095 | + */ |
1096 | +/** |
1097 | + * APP_INDICATOR: |
1098 | + * @obj: The object to convert |
1099 | + * |
1100 | + * Safely convert a #GObject into an #AppIndicator. |
1101 | + */ |
1102 | +/** |
1103 | + * APP_INDICATOR_CLASS: |
1104 | + * @klass: #GObjectClass based class to convert. |
1105 | + * |
1106 | + * Safely convert a #GObjectClass into a #AppIndicatorClass. |
1107 | + */ |
1108 | +/** |
1109 | + * IS_APP_INDICATOR: |
1110 | + * @obj: An #GObject to check |
1111 | + * |
1112 | + * Checks to see if @obj is in the object hierarchy of #AppIndicator. |
1113 | + */ |
1114 | +/** |
1115 | + * IS_APP_INDICATOR_CLASS: |
1116 | + * @klass: An #GObjectClass to check |
1117 | + * |
1118 | + * Checks to see if @klass is in the object class hierarchy of #AppIndicatorClass. |
1119 | + */ |
1120 | +/** |
1121 | + * APP_INDICATOR_GET_CLASS: |
1122 | + * @obj: A #GObject in the class hierarchy of #AppIndicator. |
1123 | + * |
1124 | + * Gets a pointer to the #AppIndicatorClass for the object @obj. |
1125 | + */ |
1126 | |
1127 | #define APP_INDICATOR_TYPE (app_indicator_get_type ()) |
1128 | #define APP_INDICATOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), APP_INDICATOR_TYPE, AppIndicator)) |
1129 | @@ -78,40 +78,40 @@ |
1130 | #define APP_INDICATOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), APP_INDICATOR_TYPE, AppIndicatorClass)) |
1131 | |
1132 | /** |
1133 | - APP_INDICATOR_SIGNAL_NEW_ICON: |
1134 | - |
1135 | - String identifier for the #AppIndicator::new-icon signal. |
1136 | -*/ |
1137 | -/** |
1138 | - APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON: |
1139 | - |
1140 | - String identifier for the #AppIndicator::new-attention-icon signal. |
1141 | -*/ |
1142 | -/** |
1143 | - APP_INDICATOR_SIGNAL_NEW_STATUS: |
1144 | - |
1145 | - String identifier for the #AppIndicator::new-status signal. |
1146 | -*/ |
1147 | -/** |
1148 | - APP_INDICATOR_SIGNAL_NEW_LABEL: |
1149 | - |
1150 | - String identifier for the #AppIndicator::new-label signal. |
1151 | -*/ |
1152 | -/** |
1153 | - APP_INDICATOR_SIGNAL_CONNECTION_CHANGED: |
1154 | - |
1155 | - String identifier for the #AppIndicator::connection-changed signal. |
1156 | -*/ |
1157 | -/** |
1158 | - APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH: |
1159 | - |
1160 | - String identifier for the #AppIndicator::new-icon-theme-path signal. |
1161 | -*/ |
1162 | -/** |
1163 | - APP_INDICATOR_SIGNAL_SCROLL_EVENT: |
1164 | - |
1165 | - String identifier for the #AppIndicator::scroll-event signal. |
1166 | -*/ |
1167 | + * APP_INDICATOR_SIGNAL_NEW_ICON: |
1168 | + * |
1169 | + * String identifier for the #AppIndicator::new-icon signal. |
1170 | + */ |
1171 | +/** |
1172 | + * APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON: |
1173 | + * |
1174 | + * String identifier for the #AppIndicator::new-attention-icon signal. |
1175 | + */ |
1176 | +/** |
1177 | + * APP_INDICATOR_SIGNAL_NEW_STATUS: |
1178 | + * |
1179 | + * String identifier for the #AppIndicator::new-status signal. |
1180 | + */ |
1181 | +/** |
1182 | + * APP_INDICATOR_SIGNAL_NEW_LABEL: |
1183 | + * |
1184 | + * String identifier for the #AppIndicator::new-label signal. |
1185 | + */ |
1186 | +/** |
1187 | + * APP_INDICATOR_SIGNAL_CONNECTION_CHANGED: |
1188 | + * |
1189 | + * String identifier for the #AppIndicator::connection-changed signal. |
1190 | + */ |
1191 | +/** |
1192 | + * APP_INDICATOR_SIGNAL_NEW_ICON_THEME_PATH: |
1193 | + * |
1194 | + * String identifier for the #AppIndicator::new-icon-theme-path signal. |
1195 | + */ |
1196 | +/** |
1197 | + * APP_INDICATOR_SIGNAL_SCROLL_EVENT: |
1198 | + * |
1199 | + * String identifier for the #AppIndicator::scroll-event signal. |
1200 | + */ |
1201 | #define APP_INDICATOR_SIGNAL_NEW_ICON "new-icon" |
1202 | #define APP_INDICATOR_SIGNAL_NEW_ATTENTION_ICON "new-attention-icon" |
1203 | #define APP_INDICATOR_SIGNAL_NEW_STATUS "new-status" |
1204 | @@ -121,16 +121,16 @@ |
1205 | #define APP_INDICATOR_SIGNAL_SCROLL_EVENT "scroll-event" |
1206 | |
1207 | /** |
1208 | - AppIndicatorCategory: |
1209 | - @APP_INDICATOR_CATEGORY_APPLICATION_STATUS: The indicator is used to display the status of the application. |
1210 | - @APP_INDICATOR_CATEGORY_COMMUNICATIONS: The application is used for communication with other people. |
1211 | - @APP_INDICATOR_CATEGORY_SYSTEM_SERVICES: A system indicator relating to something in the user's system. |
1212 | - @APP_INDICATOR_CATEGORY_HARDWARE: An indicator relating to the user's hardware. |
1213 | - @APP_INDICATOR_CATEGORY_OTHER: Something not defined in this enum, please don't use unless you really need it. |
1214 | - |
1215 | - The category provides grouping for the indicators so that |
1216 | - users can find indicators that are similar together. |
1217 | -*/ |
1218 | + * AppIndicatorCategory: |
1219 | + * @APP_INDICATOR_CATEGORY_APPLICATION_STATUS: The indicator is used to display the status of the application. |
1220 | + * @APP_INDICATOR_CATEGORY_COMMUNICATIONS: The application is used for communication with other people. |
1221 | + * @APP_INDICATOR_CATEGORY_SYSTEM_SERVICES: A system indicator relating to something in the user's system. |
1222 | + * @APP_INDICATOR_CATEGORY_HARDWARE: An indicator relating to the user's hardware. |
1223 | + * @APP_INDICATOR_CATEGORY_OTHER: Something not defined in this enum, please don't use unless you really need it. |
1224 | + * |
1225 | + * The category provides grouping for the indicators so that |
1226 | + * users can find indicators that are similar together. |
1227 | + */ |
1228 | typedef enum { /*< prefix=APP_INDICATOR_CATEGORY >*/ |
1229 | APP_INDICATOR_CATEGORY_APPLICATION_STATUS, /*< nick=ApplicationStatus >*/ |
1230 | APP_INDICATOR_CATEGORY_COMMUNICATIONS, /*< nick=Communications >*/ |
1231 | @@ -140,16 +140,16 @@ |
1232 | } AppIndicatorCategory; |
1233 | |
1234 | /** |
1235 | - AppIndicatorStatus: |
1236 | - @APP_INDICATOR_STATUS_PASSIVE: The indicator should not be shown to the user. |
1237 | - @APP_INDICATOR_STATUS_ACTIVE: The indicator should be shown in it's default state. |
1238 | - @APP_INDICATOR_STATUS_ATTENTION: The indicator should show it's attention icon. |
1239 | - |
1240 | - These are the states that the indicator can be on in |
1241 | - the user's panel. The indicator by default starts |
1242 | - in the state @APP_INDICATOR_STATUS_PASSIVE and can be |
1243 | - shown by setting it to @APP_INDICATOR_STATUS_ACTIVE. |
1244 | -*/ |
1245 | + * AppIndicatorStatus: |
1246 | + * @APP_INDICATOR_STATUS_PASSIVE: The indicator should not be shown to the user. |
1247 | + * @APP_INDICATOR_STATUS_ACTIVE: The indicator should be shown in it's default state. |
1248 | + * @APP_INDICATOR_STATUS_ATTENTION: The indicator should show it's attention icon. |
1249 | + * |
1250 | + * These are the states that the indicator can be on in |
1251 | + * the user's panel. The indicator by default starts |
1252 | + * in the state @APP_INDICATOR_STATUS_PASSIVE and can be |
1253 | + * shown by setting it to @APP_INDICATOR_STATUS_ACTIVE. |
1254 | + */ |
1255 | typedef enum { /*< prefix=APP_INDICATOR_STATUS >*/ |
1256 | APP_INDICATOR_STATUS_PASSIVE, /*< nick=Passive >*/ |
1257 | APP_INDICATOR_STATUS_ACTIVE, /*< nick=Active >*/ |
1258 | @@ -161,30 +161,30 @@ |
1259 | typedef struct _AppIndicatorPrivate AppIndicatorPrivate; |
1260 | |
1261 | /** |
1262 | - AppIndicatorClass: |
1263 | - @parent_class: Mia familia |
1264 | - @new_icon: Slot for #AppIndicator::new-icon. |
1265 | - @new_attention_icon: Slot for #AppIndicator::new-attention-icon. |
1266 | - @new_status: Slot for #AppIndicator::new-status. |
1267 | - @new_icon_theme_path: Slot for #AppIndicator::new-icon-theme-path |
1268 | - @new_label: Slot for #AppIndicator::new-label. |
1269 | - @connection_changed: Slot for #AppIndicator::connection-changed. |
1270 | - @scroll_event: Slot for #AppIndicator::scroll-event |
1271 | - @app_indicator_reserved_ats: Reserved for future use. |
1272 | - @fallback: Function that gets called to make a #GtkStatusIcon when |
1273 | - there is no Application Indicator area available. |
1274 | - @unfallback: The function that gets called if an Application |
1275 | - Indicator area appears after the fallback has been created. |
1276 | - @app_indicator_reserved_1: Reserved for future use. |
1277 | - @app_indicator_reserved_2: Reserved for future use. |
1278 | - @app_indicator_reserved_3: Reserved for future use. |
1279 | - @app_indicator_reserved_4: Reserved for future use. |
1280 | - @app_indicator_reserved_5: Reserved for future use. |
1281 | - @app_indicator_reserved_6: Reserved for future use. |
1282 | - |
1283 | - The signals and external functions that make up the #AppIndicator |
1284 | - class object. |
1285 | -*/ |
1286 | + * AppIndicatorClass: |
1287 | + * @parent_class: Mia familia |
1288 | + * @new_icon: Slot for #AppIndicator::new-icon. |
1289 | + * @new_attention_icon: Slot for #AppIndicator::new-attention-icon. |
1290 | + * @new_status: Slot for #AppIndicator::new-status. |
1291 | + * @new_icon_theme_path: Slot for #AppIndicator::new-icon-theme-path |
1292 | + * @new_label: Slot for #AppIndicator::new-label. |
1293 | + * @connection_changed: Slot for #AppIndicator::connection-changed. |
1294 | + * @scroll_event: Slot for #AppIndicator::scroll-event |
1295 | + * @app_indicator_reserved_ats: Reserved for future use. |
1296 | + * @fallback: Function that gets called to make a #GtkStatusIcon when |
1297 | + * there is no Application Indicator area available. |
1298 | + * @unfallback: The function that gets called if an Application |
1299 | + * Indicator area appears after the fallback has been created. |
1300 | + * @app_indicator_reserved_1: Reserved for future use. |
1301 | + * @app_indicator_reserved_2: Reserved for future use. |
1302 | + * @app_indicator_reserved_3: Reserved for future use. |
1303 | + * @app_indicator_reserved_4: Reserved for future use. |
1304 | + * @app_indicator_reserved_5: Reserved for future use. |
1305 | + * @app_indicator_reserved_6: Reserved for future use. |
1306 | + * |
1307 | + * The signals and external functions that make up the #AppIndicator |
1308 | + * class object. |
1309 | + */ |
1310 | struct _AppIndicatorClass { |
1311 | /* Parent */ |
1312 | GObjectClass parent_class; |
1313 | @@ -232,19 +232,18 @@ |
1314 | }; |
1315 | |
1316 | /** |
1317 | - AppIndicator: |
1318 | - |
1319 | - A application indicator represents the values that are needed to show a |
1320 | - unique status in the panel for an application. In general, applications |
1321 | - should try to fit in the other indicators that are available on the |
1322 | - panel before using this. But, sometimes it is necissary. |
1323 | -*/ |
1324 | -/* Private fields |
1325 | - @parent: Parent object. |
1326 | - @priv: Internal data. |
1327 | -*/ |
1328 | + * AppIndicator: |
1329 | + * |
1330 | + * A application indicator represents the values that are needed to show a |
1331 | + * unique status in the panel for an application. In general, applications |
1332 | + * should try to fit in the other indicators that are available on the |
1333 | + * panel before using this. But, sometimes it is necissary. |
1334 | + * |
1335 | + * Private fields |
1336 | + * @parent: Parent object. |
1337 | + * @priv: Internal data. |
1338 | + */ |
1339 | struct _AppIndicator { |
1340 | - /*< Private >*/ |
1341 | GObject parent; |
1342 | |
1343 | /*< Private >*/ |
1344 | @@ -296,6 +295,7 @@ |
1345 | const gchar * app_indicator_get_icon_theme_path (AppIndicator *self); |
1346 | const gchar * app_indicator_get_attention_icon (AppIndicator *self); |
1347 | const gchar * app_indicator_get_attention_icon_desc (AppIndicator *self); |
1348 | + |
1349 | GtkMenu * app_indicator_get_menu (AppIndicator *self); |
1350 | const gchar * app_indicator_get_label (AppIndicator *self); |
1351 | const gchar * app_indicator_get_label_guide (AppIndicator *self); |
1352 | @@ -310,20 +310,20 @@ |
1353 | G_END_DECLS |
1354 | |
1355 | /** |
1356 | - SECTION:app-indicator |
1357 | - @short_description: An object to put application information |
1358 | - into the panel. |
1359 | - @stability: Unstable |
1360 | - @include: libappindicator/app-indicator.h |
1361 | - |
1362 | - An application indicator is a way for an application to put |
1363 | - a menu into the panel on the user's screen. This allows the |
1364 | - user to interact with the application even though it might |
1365 | - not be visible to the user at the time. In most cases this |
1366 | - is not a good solution as there are other ways to inform the |
1367 | - user. It should only be use if persistence is a desired |
1368 | - feature for the user (not for your marketing purpose of |
1369 | - having your logo in the panel). |
1370 | -*/ |
1371 | + * SECTION:app-indicator |
1372 | + * @short_description: An object to put application information |
1373 | + * into the panel. |
1374 | + * @stability: Unstable |
1375 | + * @include: libappindicator/app-indicator.h |
1376 | + * |
1377 | + * An application indicator is a way for an application to put |
1378 | + * a menu into the panel on the user's screen. This allows the |
1379 | + * user to interact with the application even though it might |
1380 | + * not be visible to the user at the time. In most cases this |
1381 | + * is not a good solution as there are other ways to inform the |
1382 | + * user. It should only be use if persistence is a desired |
1383 | + * feature for the user (not for your marketing purpose of |
1384 | + * having your logo in the panel). |
1385 | + */ |
1386 | |
1387 | #endif |
Sucks that g-ir-scanner can only use that format as I like the other one better :-) Thanks for converting everything!