Skip to content

Commit c229a50

Browse files
committed
Completed documentation of Wildcard.h
1 parent a98b66d commit c229a50

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

src/Wildcard.h

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,28 @@ namespace shellanything
8282
/// <param name="oIndexes">The offsets where wildcard characters was found.</param>
8383
void FindWildcardCharacters(const char * iString, int iOffset, IntList & oIndexes);
8484

85-
//Processes iWildcard and finds expanding parameters in order to convert iWildcard to iValue
85+
/// <summary>
86+
/// Processes iWildcard and finds expanding parameters in order to convert iWildcard to iValue.
87+
/// </summary>
88+
/// <param name="iWildcard">The pattern string.</param>
89+
/// <param name="iValue">The value to test.</param>
90+
/// <param name="oList">The list of WILDCARD findings.</param>
91+
/// <returns>Returns true if iWildcard can be expanded to match iValue. Returns false otherwise.</returns>
8692
bool WildcardSolve(const char * iWildcard, const char * iValue, WildcardList & oList);
8793

88-
//Returns true if iWildcard can be expanded to match iValue.
94+
/// <summary>
95+
/// Returns true if iWildcard can be expanded to match iValue.
96+
/// </summary>
97+
/// <param name="iWildcard">The pattern string.</param>
98+
/// <param name="iValue">The value to test.</param>
99+
/// <returns>Returns true if iWildcard can be expanded to match iValue. Returns false otherwise.</returns>
89100
bool WildcardMatch(const char * iWildcard, const char * iValue);
90101

91-
//Returns all wildcard characters and index from iString groupped by wildcard character
102+
/// <summary>
103+
/// Returns all wildcard characters and index from iString groupped by wildcard character.
104+
/// </summary>
105+
/// <param name="iString">The pattern string.</param>
106+
/// <returns>Returns all wildcard characters and index from iString groupped by wildcard character</returns>
92107
WildcardGroupList FindWildcardGroups(const char * iString);
93108

94109
} //namespace shellanything

0 commit comments

Comments
 (0)