Author: jfthomps
Date: Wed Mar 11 20:30:26 2009
New Revision: 752605
URL: http://svn.apache.org/viewvc?rev=752605&view=rev
Log:
VCL-78
tweaked headers for XMLRPCblockAllocation and XMLRPCprocessBlockTime to produce
more nicely formatted output when running doxygen
Modified:
incubator/vcl/trunk/web/.ht-inc/xmlrpcWrappers.php
Modified: incubator/vcl/trunk/web/.ht-inc/xmlrpcWrappers.php
URL:
http://svn.apache.org/viewvc/incubator/vcl/trunk/web/.ht-inc/xmlrpcWrappers.php?rev=752605&r1=752604&r2=752605&view=diff
==============================================================================
--- incubator/vcl/trunk/web/.ht-inc/xmlrpcWrappers.php (original)
+++ incubator/vcl/trunk/web/.ht-inc/xmlrpcWrappers.php Wed Mar 11 20:30:26 2009
@@ -465,27 +465,28 @@
///
/// \return an array with blockTimesid as an index with the value of the newly
/// created block time and at least one other index named 'status' which will
-/// have one of these values\n
+/// have one of these values:\n
/// \b error - error occurred; there will be 2 additional elements in the
array:
-/// \li \b errorcode - error number\n
-/// \li \b errormsg - error string\n
+/// \li \b errorcode - error number
+/// \li \b errormsg - error string
+///
/// \b success - blockTimesid was processed; there will be two additional
-/// elements in this case:\n
-/// \li \b allocated - total number of desired requests that have been
-/// allocated\n
+/// elements in this case:
+/// \li \b allocated - total number of desired requests that have been
allocated
/// \li \b unallocated - total number of desired requests that have not been
-/// allocated\n
+/// allocated
+///
/// \b warning - there was a non-fatal issue that occurred while processing
-/// the call; there will be four additional elements in this case:\n
-/// \li \b warningcode - warning number\n
-/// \li \b warningmsg - warning string\n
-/// \li \b allocated - total number of desired requests that have been
-/// allocated\n
+/// the call; there will be four additional elements in this case:
+/// \li \b warningcode - warning number
+/// \li \b warningmsg - warning string
+/// \li \b allocated - total number of desired requests that have been
allocated
/// \li \b unallocated - total number of desired requests that have not been
-/// allocated\n
+/// allocated
+///
/// note that status may be warning, but allocated may be 0 indicating there
/// were no errors that occurred, but there simply were not any machines
-/// available\n
+/// available
///
/// \brief creates and processes a block reservation according to the passed
/// in criteria
@@ -551,28 +552,29 @@
/// access to through the privilege tree
///
/// \return an array with at least one index named 'status' which will have
-/// one of these values\n
+/// one of these values:\n
/// \b error - error occurred; there will be 2 additional elements in the
array:
-/// \li \b errorcode - error number\n
-/// \li \b errormsg - error string\n
+/// \li \b errorcode - error number
+/// \li \b errormsg - error string
+///
/// \b completed - blockTimesid was previously successfully processed\n
/// \b success - blockTimesid was processed; there will be two additional
-/// elements in this case:\n
-/// \li \b allocated - total number of desired requests that have been
-/// allocated\n
+/// elements in this case:
+/// \li \b allocated - total number of desired requests that have been
allocated
/// \li \b unallocated - total number of desired requests that have not been
-/// allocated\n
+/// allocated
+///
/// \b warning - there was a non-fatal issue that occurred while processing
-/// the call; there will be four additional elements in this case:\n
-/// \li \b warningcode - warning number\n
-/// \li \b warningmsg - warning string\n
-/// \li \b allocated - total number of desired requests that have been
-/// allocated\n
+/// the call; there will be four additional elements in this case:
+/// \li \b warningcode - warning number
+/// \li \b warningmsg - warning string
+/// \li \b allocated - total number of desired requests that have been
allocated
/// \li \b unallocated - total number of desired requests that have not been
-/// allocated\n
+/// allocated
+///
/// note that status may be warning, but allocated may be 0 indicating there
/// were no errors that occurred, but there simply were not any machines
-/// available\n
+/// available
///
/// \brief processes a block reservation for the blockTimes entry associated
/// with blockTimesid
