Fix up comments

This commit is contained in:
Tristan Penman 2019-09-24 20:13:46 +10:00
parent c4f15c92cc
commit caff3cdbd9

View File

@ -115,6 +115,13 @@ private:
Subschemas subschemas; Subschemas subschemas;
}; };
/**
* @brief Represents a combination 'if', 'then' and 'else' constraints
*
* The schema provided by an 'if' constraint is used as the expression for a conditional. When the
* target validates against that schema, the 'then' subschema will be also be tested. Otherwise,
* the 'else' subschema will be tested.
*/
class ConditionalConstraint: public BasicConstraint<ConditionalConstraint> class ConditionalConstraint: public BasicConstraint<ConditionalConstraint>
{ {
public: public:
@ -168,8 +175,8 @@ private:
/** /**
* @brief Represents a 'contains' constraint * @brief Represents a 'contains' constraint
* *
* An contains constraint provides a collection of values that must be present * A 'contains' constraint specifies a schema that must be satisfied by at least one
* in an array. * of the values in an array.
*/ */
class ContainsConstraint: public BasicConstraint<ContainsConstraint> class ContainsConstraint: public BasicConstraint<ContainsConstraint>
{ {