summaryrefslogtreecommitdiff
path: root/includes/database/query.inc
diff options
context:
space:
mode:
Diffstat (limited to 'includes/database/query.inc')
-rw-r--r--includes/database/query.inc12
1 files changed, 10 insertions, 2 deletions
diff --git a/includes/database/query.inc b/includes/database/query.inc
index 7186c5a6a..dd6a4da9a 100644
--- a/includes/database/query.inc
+++ b/includes/database/query.inc
@@ -108,6 +108,8 @@ interface QueryAlterableInterface {
*
* @param $tag
* The tag to add.
+ * @return
+ * The called object.
*/
public function addTag($tag);
@@ -154,7 +156,8 @@ interface QueryAlterableInterface {
* follows the same rules as any other PHP identifier.
* @param $object
* The additional data to add to the query. May be any valid PHP variable.
- *
+ * @return
+ * The called object.
*/
public function addMetaData($key, $object);
@@ -201,7 +204,12 @@ abstract class Query {
abstract protected function execute();
/**
- * Returns the query as a prepared statement string.
+ * __toString() magic method.
+ *
+ * The toString operation is how we compile a query object to a prepared statement.
+ *
+ * @return
+ * A prepared statement query string for this object.
*/
abstract public function __toString();
}