Quam Plures

Merge lp:~edb/quam-plures/docblock_error_fixes into lp:quam-plures

  1. docblock_error_fixes
  2. Merge into trunk
Proposed by EdB
Status: Merged
Merged at revision: 7599
Proposed branch: lp:~edb/quam-plures/docblock_error_fixes
Merge into: lp:quam-plures
Diff against target: 348 lines (+99/-17)
6 files modified
qp_plugins/captcha_img_plugin/_captcha_img.plugin.php (+15/-13)
qp_plugins/twitter_plugin/_callback.php (+10/-0)
qp_plugins/twitter_plugin/twitteroauth/oAuth.php (+46/-2)
qp_plugins/twitter_plugin/twitteroauth/twitteroauth.php (+22/-2)
qp_templates/_credits.disp.php (+3/-0)
qp_templates/basic/_credits.disp.php (+3/-0)
To merge this branch: bzr merge lp:~edb/quam-plures/docblock_error_fixes
Reviewer Review Type Date Requested Status
Yabs (community) Approve
Review via email: mp+54023@code.launchpad.net
To post a comment you must log in.
Revision history for this message
Yabs (yabs) wrote :

Easy one ;)

¥

review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'qp_plugins/captcha_img_plugin/_captcha_img.plugin.php'
2--- qp_plugins/captcha_img_plugin/_captcha_img.plugin.php 2010-11-02 14:33:07 +0000
3+++ qp_plugins/captcha_img_plugin/_captcha_img.plugin.php 2011-03-18 16:13:15 +0000
4@@ -1035,9 +1035,9 @@
5 }
6
7
8- /* PRIVATE methods */
9-
10- // Get plugin settings that apply to registered members.
11+ /**
12+ * Get plugin settings that apply to registered members
13+ */
14 function does_apply( $params, $blog_context )
15 {
16 global $current_User;
17@@ -1091,7 +1091,9 @@
18 }
19
20
21- // BeforeInsert routine for comments, contact forms, and registration form.
22+ /**
23+ * BeforeInsert routine for comments, contact forms, and registration form
24+ */
25 function insert_item( $params )
26 {
27 $prefix = 'captcha_img_'.$this->ID;
28@@ -1134,7 +1136,6 @@
29 /**
30 * Generate a private key.
31 *
32- * @access private
33 * @return string
34 */
35 function generate_private_key()
36@@ -1180,7 +1181,6 @@
37 /**
38 * Create captcha image.
39 *
40- * @access private
41 * @return string The generated captcha image (binary data).
42 */
43 function get_captcha_img( $private_key )
44@@ -1399,7 +1399,6 @@
45 /**
46 * Get the GD version out of buffered phpinfo output.
47 *
48- * @access private
49 * @return string|0 Either the parsed version or 0 if no GD library available.
50 */
51 function get_gd_version()
52@@ -1425,7 +1424,9 @@
53 }
54
55
56- // @private
57+ /**
58+ * dummy docblock makes error-free autodocs
59+ */
60 function makeWebsafeColors(&$image)
61 {
62 //$a = array();
63@@ -1445,8 +1446,9 @@
64 }
65
66
67- // @private
68-
69+ /**
70+ * dummy docblock makes error-free autodocs
71+ */
72 function random_color($min,$max)
73 {
74 $this->rand_R = intval(mt_rand($min,$max));
75@@ -1455,7 +1457,9 @@
76 }
77
78
79- // @private
80+ /**
81+ * dummy docblock makes error-free autodocs
82+ */
83 function change_TTF()
84 {
85 $key = array_rand($this->TTF_RANGE);
86@@ -1467,8 +1471,6 @@
87
88 /**
89 * Check if GD is available with our requirements.
90- *
91- * @access private
92 */
93 function validate_gd_requirements()
94 {
95
96=== modified file 'qp_plugins/twitter_plugin/_callback.php'
97--- qp_plugins/twitter_plugin/_callback.php 2010-10-17 17:23:45 +0000
98+++ qp_plugins/twitter_plugin/_callback.php 2011-03-18 16:13:15 +0000
99@@ -48,9 +48,19 @@
100 * @subpackage Twitter
101 */
102
103+/**
104+ * dummy docblock makes error-free autodocs
105+ */
106 require_once dirname(__FILE__).'/../../qp_config/_config.php';
107+/**
108+ * dummy docblock makes error-free autodocs
109+ */
110 require_once dirname(__FILE__).'/twitteroauth/twitteroauth.php';
111+/**
112+ * dummy docblock makes error-free autodocs
113+ */
114 require_once $inc_path.'_main.inc.php';
115+
116 load_funcs('_core/_param.funcs.php');
117
118 global $Session;
119
120=== modified file 'qp_plugins/twitter_plugin/twitteroauth/oAuth.php'
121--- qp_plugins/twitter_plugin/twitteroauth/oAuth.php 2010-10-17 17:23:45 +0000
122+++ qp_plugins/twitter_plugin/twitteroauth/oAuth.php 2011-03-18 16:13:15 +0000
123@@ -12,12 +12,22 @@
124
125 /**
126 * Generic exception class
127+ *
128+ * @package plugins
129+ * @subpackage Twitter
130 */
131 class OAuthException extends Exception
132 {
133 // pass
134 }
135
136+
137+/**
138+ * Generic exception class
139+ *
140+ * @package plugins
141+ * @subpackage Twitter
142+ */
143 class OAuthConsumer
144 {
145 public $key;
146@@ -46,6 +56,9 @@
147
148 /**
149 * dummy docblock makes error-free autodocs
150+ *
151+ * @package plugins
152+ * @subpackage Twitter
153 */
154 class OAuthToken
155 {
156@@ -90,6 +103,9 @@
157 /**
158 * A class for implementing a Signature Method
159 * See section 9 ("Signing Requests") in the spec
160+ *
161+ * @package plugins
162+ * @subpackage Twitter
163 */
164 abstract class OAuthSignatureMethod
165 {
166@@ -135,9 +151,13 @@
167 * encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'
168 * character (ASCII code 38) even if empty.
169 * - Chapter 9.2 ("HMAC-SHA1")
170+ *
171+ * @package plugins
172+ * @subpackage Twitter
173 */
174 class OAuthSignatureMethod_HMAC_SHA1 extends OAuthSignatureMethod
175 {
176+
177 /**
178 * dummy docblock makes error-free autodocs
179 */
180@@ -173,6 +193,9 @@
181 * The PLAINTEXT method does not provide any security protection and SHOULD only be used
182 * over a secure channel such as HTTPS. It does not use the Signature Base String.
183 * - Chapter 9.4 ("PLAINTEXT")
184+ *
185+ * @package plugins
186+ * @subpackage Twitter
187 */
188 class OAuthSignatureMethod_PLAINTEXT extends OAuthSignatureMethod
189 {
190@@ -217,6 +240,9 @@
191 * verified way to the Service Provider, in a manner which is beyond the scope of this
192 * specification.
193 * - Chapter 9.3 ("RSA-SHA1")
194+ *
195+ * @package plugins
196+ * @subpackage Twitter
197 */
198 abstract class OAuthSignatureMethod_RSA_SHA1 extends OAuthSignatureMethod
199 {
200@@ -229,6 +255,7 @@
201 return "RSA-SHA1";
202 }
203
204+
205 /**
206 * dummy docblock makes error-free autodocs
207 * Up to the SP to implement this lookup of keys. Possible ideas are:
208@@ -303,6 +330,9 @@
209
210 /**
211 * dummy docblock makes error-free autodocs
212+ *
213+ * @package plugins
214+ * @subpackage Twitter
215 */
216 class OAuthRequest
217 {
218@@ -587,6 +617,10 @@
219 $this->set_parameter("oauth_signature", $signature, false);
220 }
221
222+
223+ /**
224+ * dummy docblock makes error-free autodocs
225+ */
226 public function build_signature($signature_method, $consumer, $token) {
227 $signature = $signature_method->build_signature($this, $consumer, $token);
228 return $signature;
229@@ -617,6 +651,9 @@
230
231 /**
232 * dummy docblock makes error-free autodocs
233+ *
234+ * @package plugins
235+ * @subpackage Twitter
236 */
237 class OAuthServer
238 {
239@@ -859,6 +896,9 @@
240
241 /**
242 * dummy docblock makes error-free autodocs
243+ *
244+ * @package plugins
245+ * @subpackage Twitter
246 */
247 class OAuthDataStore
248 {
249@@ -914,6 +954,9 @@
250
251 /**
252 * dummy docblock makes error-free autodocs
253+ *
254+ * @package plugins
255+ * @subpackage Twitter
256 */
257 class OAuthUtil
258 {
259@@ -949,8 +992,9 @@
260
261
262 /**
263- * Utility function for turning the Authorization: header into
264- * parameters, has to do some unescaping
265+ * Utility function
266+ *
267+ * Turning the Authorization: header into parameters, has to do some unescaping.
268 * Can filter out any non-oauth parameters if needed (default behaviour)
269 */
270 public static function split_header($header, $only_allow_oauth_parameters = true)
271
272=== modified file 'qp_plugins/twitter_plugin/twitteroauth/twitteroauth.php'
273--- qp_plugins/twitter_plugin/twitteroauth/twitteroauth.php 2010-10-17 17:23:45 +0000
274+++ qp_plugins/twitter_plugin/twitteroauth/twitteroauth.php 2011-03-18 16:13:15 +0000
275@@ -26,7 +26,7 @@
276 * Twitter OAuth class
277 *
278 * @package plugins
279- * @subpackage NewTwitter
280+ * @subpackage Twitter
281 */
282 class TwitterOAuth
283 {
284@@ -58,15 +58,35 @@
285 * Set API URLS
286 */
287 function accessTokenURL() { return 'https://api.twitter.com/oauth/access_token'; }
288+
289+
290+ /**
291+ * Set API URLS
292+ */
293 function authenticateURL() { return 'https://twitter.com/oauth/authenticate'; }
294+
295+
296+ /**
297+ * Set API URLS
298+ */
299 function authorizeURL() { return 'https://twitter.com/oauth/authorize'; }
300+
301+
302+ /**
303+ * Set API URLS
304+ */
305 function requestTokenURL() { return 'https://api.twitter.com/oauth/request_token'; }
306
307
308 /**
309- * Debug helpers
310+ * Debug helper
311 */
312 function lastStatusCode() { return $this->http_status; }
313+
314+
315+ /**
316+ * Debug helper
317+ */
318 function lastAPICall() { return $this->last_api_call; }
319
320
321
322=== modified file 'qp_templates/_credits.disp.php'
323--- qp_templates/_credits.disp.php 2011-01-09 15:04:20 +0000
324+++ qp_templates/_credits.disp.php 2011-03-18 16:13:15 +0000
325@@ -94,6 +94,9 @@
326 if( in_array( 'contribs', $credits_array ) )
327 {
328 global $templates_path;
329+ /**
330+ * dummy docblock makes error-free autodocs
331+ */
332 require_once $templates_path.'/_contributors.php'; // contributors links
333
334 echo '<dt>'.T_('Core Contributors').':</dt>'."\n";
335
336=== modified file 'qp_templates/basic/_credits.disp.php'
337--- qp_templates/basic/_credits.disp.php 2010-10-17 15:32:23 +0000
338+++ qp_templates/basic/_credits.disp.php 2011-03-18 16:13:15 +0000
339@@ -100,6 +100,9 @@
340 if( in_array( 'contribs', $credits_array ) )
341 {
342 global $templates_path;
343+ /**
344+ * dummy docblock makes error-free autodocs
345+ */
346 require_once $templates_path.'/_contributors.php'; // contributors links
347
348 echo '<dt>'.T_('Core Contributors').':</dt>'."\n";

Subscribers

People subscribed via source and target branches