svn commit: r1659651 - /vcl/trunk/web/.ht-inc/xmlrpcWrappers.php

[jf...@apache.org]

Author: jfthomps
Date: Fri Feb 13 19:15:09 2015
New Revision: 1659651

URL: http://svn.apache.org/r1659651
Log:
updates for running doxygen to generate documentation

-modified header for XMLRPCaddRequestWithEnding: missing 3rd '/' at beginning of line for $nousercheck argument
-modified header for XMLRPCgetUserGroups: removed \b for each item listed in return section; doxygen was unhappy with them (maybe because there is no description after them?)
-modified header for XMLRPCfinishBaseImageCapture: 1st parameter is $ownerid, first documented param was $ownerdata; changed to $ownerid

Modified:
    vcl/trunk/web/.ht-inc/xmlrpcWrappers.php

Modified: vcl/trunk/web/.ht-inc/xmlrpcWrappers.php
URL: http://svn.apache.org/viewvc/vcl/trunk/web/.ht-inc/xmlrpcWrappers.php?rev=1659651&r1=1659650&r2=1659651&view=diff
==============================================================================
--- vcl/trunk/web/.ht-inc/xmlrpcWrappers.php (original)
+++ vcl/trunk/web/.ht-inc/xmlrpcWrappers.php Fri Feb 13 19:15:09 2015
@@ -243,7 +243,7 @@ function XMLRPCaddRequest($imageid, $sta
 ////////////////////////////////////////////////////////////////////////////////
 ///
 /// \fn XMLRPCaddRequestWithEnding($imageid, $start, $end, $foruser,
-//                                 $nousercheck)
+///                                $nousercheck)
 ///
 /// \param $imageid - id of an image
 /// \param $start - "now" or unix timestamp for start of reservation; will
@@ -2305,22 +2305,22 @@ function _XMLRPCchangeResourceGroupPriv_
 /// \return an array with two indices, one named 'status' which will have a
 /// value of 'success', the other named 'groups' which will be an array of
 /// arrays, each one having the following keys:\n
-/// \li \b id\n
-/// \li \b name\n
-/// \li \b groupaffiliation\n
-/// \li \b groupaffiliationid\n
-/// \li \b ownerid\n
-/// \li \b owner\n
-/// \li \b affiliation\n
-/// \li \b editgroupid\n
-/// \li \b editgroup\n
-/// \li \b editgroupaffiliationid\n
-/// \li \b editgroupaffiliation\n
-/// \li \b custom\n
-/// \li \b courseroll\n
-/// \li \b initialmaxtime\n
-/// \li \b maxextendtime\n
-/// \li \b overlapResCount\n
+/// \li id\n
+/// \li name\n
+/// \li groupaffiliation\n
+/// \li groupaffiliationid\n
+/// \li ownerid\n
+/// \li owner\n
+/// \li affiliation\n
+/// \li editgroupid\n
+/// \li editgroup\n
+/// \li editgroupaffiliationid\n
+/// \li editgroupaffiliation\n
+/// \li custom\n
+/// \li courseroll\n
+/// \li initialmaxtime\n
+/// \li maxextendtime\n
+/// \li overlapResCount
 ///
 /// \brief builds a list of user groups
 ///
@@ -3660,8 +3660,7 @@ function XMLRPCprocessBlockTime($blockTi
 ///
 /// \fn XMLRPCfinishBaseImageCapture($ownerid, $resourceid, $virtual=1)
 ///
-/// \param $ownerdata - array of data returned from getUserInfo for the owner of
-/// the image
+/// \param $ownerid - id of owner of image
 /// \param $resourceid - id from resource table for the image
 /// \param $virtual - (bool) 0 if bare metal image, 1 if virtual
 ///