Some minor documentation cleanup (e.g. converted C# comments to PHPDocumentor comments)

This commit is contained in:
Jeff Moser
2010-10-08 21:44:36 -04:00
parent f863e150d4
commit d2fc7dc5c7
22 changed files with 174 additions and 159 deletions

View File

@ -2,17 +2,17 @@
namespace Moserware\Skills;
/// <summary>
/// Helper class to sort ranks in non-decreasing order.
/// </summary>
/**
* Helper class to sort ranks in non-decreasing order.
*/
class RankSorter
{
/// <summary>
/// Performs an in-place sort of the <paramref name="items"/> in according to the <paramref name="ranks"/> in non-decreasing order.
/// </summary>
/// <typeparam name="T">The types of items to sort.</typeparam>
/// <param name="items">The items to sort according to the order specified by <paramref name="ranks"/>.</param>
/// <param name="ranks">The ranks for each item where 1 is first place.</param>
/**
* Performs an in-place sort of the items in according to the ranks in non-decreasing order.
*
* @param $items The items to sort according to the order specified by ranks.
* @param $ranks The ranks for each item where 1 is first place.
*/
public static function sort(array &$teams, array &$teamRanks)
{
array_multisort($teamRanks, $teams);