aboutsummaryrefslogtreecommitdiffstats
path: root/Frameworks/QueryKit
diff options
context:
space:
mode:
authorstuconnolly <stuart02@gmail.com>2011-09-12 16:50:15 +0000
committerstuconnolly <stuart02@gmail.com>2011-09-12 16:50:15 +0000
commitb9c291f25670d591b2ba9bbd3467f76bf1218e7f (patch)
tree325c135acf3999d9d5e38f74bce9869367fb82ee /Frameworks/QueryKit
parent6ce6d636928bec9c9ef80343eb53018a43b608ee (diff)
downloadsequelpro-b9c291f25670d591b2ba9bbd3467f76bf1218e7f.tar.gz
sequelpro-b9c291f25670d591b2ba9bbd3467f76bf1218e7f.tar.bz2
sequelpro-b9c291f25670d591b2ba9bbd3467f76bf1218e7f.zip
QueryKit comments.
Diffstat (limited to 'Frameworks/QueryKit')
-rw-r--r--Frameworks/QueryKit/QKQueryOperators.h10
-rw-r--r--Frameworks/QueryKit/QKQueryTypes.h7
2 files changed, 13 insertions, 4 deletions
diff --git a/Frameworks/QueryKit/QKQueryOperators.h b/Frameworks/QueryKit/QKQueryOperators.h
index 5d9852b3..247496fd 100644
--- a/Frameworks/QueryKit/QKQueryOperators.h
+++ b/Frameworks/QueryKit/QKQueryOperators.h
@@ -31,8 +31,12 @@
// More info at <http://code.google.com/p/sequel-pro/>
/**
- * Note that this is by no means complete list of available operators, only the most commonly used ones. Other
- * operators can be added as and when they are required.
+ * @enum QKQueryOperator
+ *
+ * Used to specify the operator to use for a specific query parameter.
+ *
+ * Note that this is by no means a complete list of available operators, only the most commonly used ones.
+ * Other operators can be added as and when they are required.
*/
typedef enum
{
@@ -49,4 +53,4 @@ typedef enum
QKGreaterThanOrEqualOperator,
QKLessThanOrEqualOperator
}
-QKQueryOperator; \ No newline at end of file
+QKQueryOperator;
diff --git a/Frameworks/QueryKit/QKQueryTypes.h b/Frameworks/QueryKit/QKQueryTypes.h
index 7bb51e3a..1e9e7403 100644
--- a/Frameworks/QueryKit/QKQueryTypes.h
+++ b/Frameworks/QueryKit/QKQueryTypes.h
@@ -30,6 +30,11 @@
//
// More info at <http://code.google.com/p/sequel-pro/>
+/**
+ * @enum QKQueryType
+ *
+ * Used to specify the type of query to be constructed.
+ */
typedef enum
{
QKSelectQuery,
@@ -37,4 +42,4 @@ typedef enum
QKInsertQuery,
QKDeleteQuery,
}
-QKQueryType; \ No newline at end of file
+QKQueryType;