From 970182b57de2e22dbe5abe9fd2f7f7986b0d3a0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=BCnter=20Obiltschnig?= Date: Sat, 19 Jun 2021 18:01:07 +0200 Subject: [PATCH] documentation fixes --- ActiveRecord/include/Poco/ActiveRecord/Query.h | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/ActiveRecord/include/Poco/ActiveRecord/Query.h b/ActiveRecord/include/Poco/ActiveRecord/Query.h index 486387c29..4b20907fe 100644 --- a/ActiveRecord/include/Poco/ActiveRecord/Query.h +++ b/ActiveRecord/include/Poco/ActiveRecord/Query.h @@ -31,11 +31,12 @@ class Query /// A Query is used to retrieve ActiveRecord objects from a table. /// /// As the name implies, Query supports selection of database rows - /// based on a WHERE clause (see where()). Furthermore, results can - /// be sorted (see orderBy()) and filtered based on a lambda expression - /// (see filter()). + /// based on a WHERE clause (see where()). /// - /// Optional result paging is controlled by offest() and limit(). + /// Furthermore, results can be sorted (see orderBy()) and + /// filtered based on a lambda expression (see filter()). + /// + /// Optional result paging is controlled by offset() and limit(). /// The total number of results is available via totalResults(). { public: @@ -73,7 +74,11 @@ public: template Query& bind(const T& value) - /// Bind a value to a placeholder in the where clause. + /// Bind a value to a placeholder in the where() clause. + /// + /// For each placeholder (?) in the where() clause, + /// a value must be bound with bind() before the query + /// can be executed. { _select, Poco::Data::Keywords::bind(value); return *this; @@ -88,7 +93,7 @@ public: } Query& limit(std::size_t limit) - /// specify the maximum number of rows to return for paging. + /// Specify the maximum number of rows to return for paging. { _limit = limit; return *this;