diff --git a/Foundation/CPPredicate/CPExpression.j b/Foundation/CPPredicate/CPExpression.j index 9767933ae..d8f4edfcd 100644 --- a/Foundation/CPPredicate/CPExpression.j +++ b/Foundation/CPPredicate/CPExpression.j @@ -71,9 +71,12 @@ CPMinusSetExpressionType = 9; @class CPExpression @brief CPExpression is used to represent expressions in a predicate. - Comparison operations in an CPPredicate are based on two expressions, as represented by instances of the CPExpression class. Expressions are created for constant values, key paths, and so on. + Comparison operations in an CPPredicate are based on two expressions, as represented by instances of the CPExpression class. + Expressions are created for constant values, key paths, and so on. - Generally, anywhere in the CPExpression class hierarchy where there is composite API and subtypes that may only reasonably respond to a subset of that API, invoking a method that does not make sense for that subtype will cause an exception to be thrown. + Generally, anywhere in the CPExpression class hierarchy where there is composite API and subtypes + that may only reasonably respond to a subset of that API, invoking a method that does not make sense + for that subtype will cause an exception to be thrown. */ @implementation CPExpression : CPObject @@ -182,12 +185,15 @@ CPMinusSetExpressionType = 9; Returns a new expression that will invoke one of the predefined functions. @param function_name The name of the function to invoke. @param parameters An array containing CPExpression objects that will be used as parameters during the invocation of selector. - - For a selector taking no parameters, the array should be empty. For a selector taking one or more parameters, the array should contain one CPExpression object which will evaluate to an instance of the appropriate type for each parameter. - - If there is a mismatch between the number of parameters expected and the number you provide during evaluation, an exception may be raised or missing parameters may simply be replaced by nil (which occurs depends on how many parameters are provided, and whether you have over- or underflow). @return A new expression that invokes the function name using the parameters in parameters. + For a selector taking no parameters, the array should be empty. For a selector taking one or more parameters, + the array should contain one CPExpression object which will evaluate to an instance of the appropriate type for each parameter. + + If there is a mismatch between the number of parameters expected and the number you provide during evaluation, + an exception may be raised or missing parameters may simply be replaced by nil (which occurs depends on how many + parameters are provided, and whether you have over- or underflow). + The name parameter can be one of the following predefined functions: @verbatim name parameter array contents returns @@ -220,6 +226,7 @@ CPMinusSetExpressionType = 9; now: none [CPDate now] This method raises an exception immediately if the selector is invalid; it raises an exception at runtime if the parameters are incorrect. +@endverbatim */ + (CPExpression)expressionForFunction:(CPString)function_name arguments:(CPArray)parameters { @@ -232,7 +239,8 @@ CPMinusSetExpressionType = 9; @param selectorName The name of the method to be invoked. @param parameters An array containing CPExpression objects which can be evaluated to provide parameters for the method specified by name. @return An expression which will return the result of invoking the selector named name on the result of evaluating the target expression with the parameters specified by evaluating the elements of parameters. - See the description of expressionForFunction:arguments: for examples of how to construct the parameter array. + + See the description of \c expressionForFunction:arguments: for examples of how to construct the parameter array. */ + (CPExpression)expressionForFunction:(CPExpression)target selectorName:(CPString)selectorName arguments:(CPArray)parameters { diff --git a/Foundation/CPPredicate/CPPredicate.j b/Foundation/CPPredicate/CPPredicate.j index 1e99887ec..b12a2a62f 100644 --- a/Foundation/CPPredicate/CPPredicate.j +++ b/Foundation/CPPredicate/CPPredicate.j @@ -55,7 +55,7 @@ You can create predicates for operations, such as \@sum.items.price < 1000. You can also create predicates that include variables, so that the predicate can be pre-defined before - substituting concrete values at runtime with the evaluateWithObject:substitutionVariables: method. + substituting concrete values at runtime with the \c evaluateWithObject:substitutionVariables: method. */ @implementation CPPredicate : CPObject diff --git a/Tools/Documentation/preprocess/003.make_headers.rb b/Tools/Documentation/preprocess/003.make_headers.rb index 327df1ea0..777e0772f 100755 --- a/Tools/Documentation/preprocess/003.make_headers.rb +++ b/Tools/Documentation/preprocess/003.make_headers.rb @@ -7,7 +7,7 @@ ACCESSOR_GET_TEMPLATE = < \[implementation\]"), " ", re.compile(r"Static Public Member Functions"), "Class Methods", re.compile(r"Public Member Functions"), "Instance Methods", + re.compile(r"Protected Attributes"), "Instance Variables", re.compile(r"Member Function Documentation"), "Method Documentation", + re.compile(r"Member Data Documentation"), "Instance Variable Documentation", re.compile(r"(AppKit|Foundation)\.doc"), r"\1", re.compile(r"\s*\n(\s*\n){2}\s*(){2} \n\s*"), "" ]