@@ -564,6 +564,11 @@ class ConditionGroupAll extends ConditionGroup {
564564 ConditionGroupAll (conditions) : super (conditions, bindings.obx_qb_all);
565565}
566566
567+ /// A repeatable Query returning the latest matching Objects.
568+ ///
569+ /// Use [find] or related methods to fetch the latest results from the BoxStore.
570+ ///
571+ /// Use [property] to only return values or an aggregate of a single Property.
567572class Query <T > {
568573 Pointer <Void > _cQuery;
569574 Store store;
@@ -599,6 +604,7 @@ class Query<T> {
599604 checkObx (bindings.obx_query_limit (_cQuery, limit));
600605 }
601606
607+ /// Returns the number of matching Objects.
602608 int count () {
603609 final ptr = allocate <Uint64 >(count: 1 );
604610 try {
@@ -609,6 +615,7 @@ class Query<T> {
609615 }
610616 }
611617
618+ /// Close the query and free resources.
612619 // TODO Document wrap with closure to fake auto close
613620 void close () {
614621 checkObx (bindings.obx_query_close (_cQuery));
@@ -681,12 +688,12 @@ class Query<T> {
681688 });
682689 }
683690
684- // For testing purposes
691+ /// For internal testing purposes.
685692 String describe () {
686693 return cString (bindings.obx_query_describe (_cQuery));
687694 }
688695
689- // For testing purposes
696+ /// For internal testing purposes.
690697 String describeParameters () {
691698 return cString (bindings.obx_query_describe_params (_cQuery));
692699 }
@@ -719,14 +726,17 @@ class Query<T> {
719726 }
720727 }
721728
729+ /// See [property] for details.
722730 IntegerPropertyQuery integerProperty (QueryProperty qp) {
723731 return property <IntegerPropertyQuery >(qp);
724732 }
725733
734+ /// See [property] for details.
726735 DoublePropertyQuery doubleProperty (QueryProperty qp) {
727736 return property <DoublePropertyQuery >(qp);
728737 }
729738
739+ /// See [property] for details.
730740 StringPropertyQuery stringProperty (QueryProperty qp) {
731741 return property <StringPropertyQuery >(qp);
732742 }
0 commit comments