[m] Lots of Doxygen fixes/additions - thanks to lfxGroove

This commit is contained in:
billy1arm 2013-06-23 21:43:27 +01:00 committed by Antz
parent b134615f92
commit c94dbc84c2
960 changed files with 5905 additions and 6171 deletions

View file

@ -1,4 +1,4 @@
/*
/**
@file stringutils.h
@maintainer Morgan McGuire, http://graphics.cs.williams.edu
@ -55,21 +55,21 @@ inline int findLastSlash(const std::string& f, int start = -1) {
return max(i, j);
}
/*
/**
Returns true if the test string begins with the pattern string.
*/
bool beginsWith(
const std::string& test,
const std::string& pattern);
/*
/**
Returns true if the test string ends with the pattern string.
*/
bool endsWith(
const std::string& test,
const std::string& pattern);
/*
/**
Produces a new string that is the input string
wrapped at a certain number of columns (where
the line is broken at the latest space before the
@ -80,7 +80,7 @@ std::string wordWrap(
const std::string& input,
int numCols);
/*
/**
A comparison function for passing to Array::sort.
*/
int stringCompare(
@ -91,7 +91,7 @@ int stringPtrCompare(
const std::string* s1,
const std::string* s2);
/*
/**
Returns a new string that is an uppercase version of x.
*/
std::string toUpper(
@ -100,14 +100,14 @@ std::string toUpper(
std::string toLower(
const std::string& x);
/*
/**
Splits x at each occurance of splitChar.
*/
G3D::Array<std::string> stringSplit(
const std::string& x,
char splitChar);
/*
/**
joinChar is not inserted at the beginning or end, just in between
elements.
*/
@ -119,7 +119,7 @@ std::string stringJoin(
const G3D::Array<std::string>& a,
const std::string& joinStr);
/*
/**
Strips whitespace from both ends of the string.
*/
std::string trimWhitespace(