- Patch #670250 by boombatower: more documentation clean-ups.

1 files changed, 15 insertions, 10 deletions

diff --git a/includes/xmlrpc.inc b/includes/xmlrpc.inc
index 688605bf2..161abd83f 100644
--- a/includes/xmlrpc.inc
+++ b/includes/xmlrpc.inc
@@ -3,7 +3,9 @@
 
 /**
  * @file
- * Drupal XML-RPC library. Based on the IXR - The Incutio XML-RPC Library - (c) Incutio Ltd 2002-2005
+ * Drupal XML-RPC library.
+ *
+ * Based on the IXR - The Incutio XML-RPC Library - (c) Incutio Ltd 2002-2005
  * Version 1.7 (beta) - Simon Willison, 23rd May 2005
  * Site:   http://scripts.incutio.com/xmlrpc/
  * Manual: http://scripts.incutio.com/xmlrpc/manual.php
@@ -11,11 +13,11 @@
  */
 
 /**
- * Recursively turn a data structure into objects with 'data' and 'type' attributes.
+ * Turn a data structure into objects with 'data' and 'type' attributes.
  *
  * @param $data
  *   The data structure.
- * @param  $type
+ * @param $type
  *   Optional type assign to $data.
  * @return
  *   Object.
@@ -48,8 +50,7 @@ function xmlrpc_value($data, $type = FALSE) {
  *   Variable whose type should be mapped.
  * @return
  *   XML-RPC type as string.
- * @see
- *   http://www.xmlrpc.com/spec#scalars
+ * @see http://www.xmlrpc.com/spec#scalars
  */
 function xmlrpc_value_calculate_type($xmlrpc_value) {
   // http://www.php.net/gettype: Never use gettype() to test for a certain type [...] Instead, use the is_* functions.
@@ -84,6 +85,7 @@ function xmlrpc_value_calculate_type($xmlrpc_value) {
  * Generate XML representing the given value.
  *
  * @param $xmlrpc_value
+ *   A value to be represented in XML.
  * @return
  *   XML representation of value.
  */
@@ -148,8 +150,10 @@ function xmlrpc_message($message) {
 }
 
 /**
- * Parse an XML-RPC message. If parsing fails, the faultCode and faultString
- * will be added to the message object.
+ * Parse an XML-RPC message.
+ *
+ * If parsing fails, the faultCode and faultString will be added to the message
+ * object.
  *
  * @param $xmlrpc_message
  *   Object generated by xmlrpc_message()
@@ -428,10 +432,11 @@ function xmlrpc_base64_get_xml($xmlrpc_base64) {
  *     http://www.example.com/xmlrpc.php
  * @param ...
  *   For one request:
- *     The method name followed by a variable number of arguments to the method.
+ *     The method name followed by a variable number of arguments to the
+ *     method.
  *   For multiple requests (system.multicall):
- *     An array of call arrays. Each call array follows the pattern of the single
- *     request: method name followed by the arguments to the method.
+ *     An array of call arrays. Each call array follows the pattern of the
+ *     single request: method name followed by the arguments to the method.
  * @return
  *   Either the return value of the method on success, or FALSE.  If FALSE is
  *   returned, see xmlrpc_errno() and xmlrpc_error_msg().