Mercurial > pidgin.yaz
comparison doc/PERL-HOWTO.dox @ 6720:41120df7ed94
[gaim-migrate @ 7247]
Fixed documentation errors so Doxygen no longer complains.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Wed, 03 Sep 2003 05:21:04 +0000 |
parents | 21084026030b |
children | 65acffe70a6d |
comparison
equal
deleted
inserted
replaced
6719:3cc4d5e55a69 | 6720:41120df7ed94 |
---|---|
7 plugin, and appears in the list of plugins in Gaim's preferences pane. | 7 plugin, and appears in the list of plugins in Gaim's preferences pane. |
8 Until now, they have been very basic, and consisted of only a few | 8 Until now, they have been very basic, and consisted of only a few |
9 functions. However, with the latest changes to Gaim's perl API, a much | 9 functions. However, with the latest changes to Gaim's perl API, a much |
10 larger part of Gaim is now open. In time, even such things as Gtk+ | 10 larger part of Gaim is now open. In time, even such things as Gtk+ |
11 preference panes for perl scripts will be possible. | 11 preference panes for perl scripts will be possible. |
12 @endsection | |
13 | 12 |
14 @section first-script Writing your first perl script | 13 @section first-script Writing your first perl script |
15 Enough of that. You want to know how to write a perl script, right? | 14 Enough of that. You want to know how to write a perl script, right? |
16 | 15 |
17 First off, we're going to assume here that you are familiar with perl. Perl | 16 First off, we're going to assume here that you are familiar with perl. Perl |
78 @warning Do @b NOT put any executable code outside of these functions | 77 @warning Do @b NOT put any executable code outside of these functions |
79 or your own user-defined functions. Variable declarations are | 78 or your own user-defined functions. Variable declarations are |
80 okay, as long as they're set to be local. Bad Things (TM) can | 79 okay, as long as they're set to be local. Bad Things (TM) can |
81 happen if you don't follow this simple instruction. | 80 happen if you don't follow this simple instruction. |
82 | 81 |
83 @endsection | |
84 | 82 |
85 @section Timeouts | 83 @section Timeouts |
86 One feature useful to many perl plugin writers are timeouts. Timeouts allow | 84 One feature useful to many perl plugin writers are timeouts. Timeouts allow |
87 code to be ran after a specified number of seconds, and are rather | 85 code to be ran after a specified number of seconds, and are rather |
88 simple to setup. Here's one way of registering a timeout. | 86 simple to setup. Here's one way of registering a timeout. |
129 every specified number of seconds, just re-register the timeout | 127 every specified number of seconds, just re-register the timeout |
130 at the end of the callback. | 128 at the end of the callback. |
131 | 129 |
132 The data parameter is optional. If you don't have data to pass to the | 130 The data parameter is optional. If you don't have data to pass to the |
133 callback, simply omit the parameter. | 131 callback, simply omit the parameter. |
134 @endsection | |
135 | 132 |
136 @section Signals | 133 @section Signals |
137 Signals are how gaim plugins get events. There are a number of | 134 Signals are how gaim plugins get events. There are a number of |
138 @ref Signals signals available. | 135 @ref Signals signals available. |
139 | 136 |
161 @endcode | 158 @endcode |
162 | 159 |
163 | 160 |
164 Like timeouts, the callback can be an embedded subroutine, and also | 161 Like timeouts, the callback can be an embedded subroutine, and also |
165 like timeouts, the data parameter can be omitted. | 162 like timeouts, the data parameter can be omitted. |
166 @endsection | |
167 | 163 |
168 @section Notes | 164 @section Notes |
169 The API in perl is very similar to Gaim's C API. The functions have been | 165 The API in perl is very similar to Gaim's C API. The functions have been |
170 gathered into packages, but most are the same, and the documentation can | 166 gathered into packages, but most are the same, and the documentation can |
171 be a big help at times. | 167 be a big help at times. |
172 @endsection | |
173 | 168 |
174 @section Resources | 169 @section Resources |
175 @see Signals | 170 @see Signals |
176 @see Perl API Reference | 171 @see Perl API Reference |
177 @endsection | |
178 | 172 |
179 */ | 173 */ |
180 // vim: syntax=c tw=75 et | 174 // vim: syntax=c tw=75 et |