Skip to content

Commit 2aa77b9

Browse files
author
Ajay Kannan
committed
Fix javadoc wording and location
1 parent 5f01eb9 commit 2aa77b9

File tree

1 file changed

+22
-24
lines changed

1 file changed

+22
-24
lines changed

gcloud-java-datastore/src/main/java/com/google/gcloud/datastore/StructuredQuery.java

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ static Filter fromPb(DatastoreV1.Filter filterPb) {
113113
}
114114
}
115115

116-
/*
116+
/**
117117
* A class representing a filter composed of a combination of other filters.
118118
*/
119119
public static final class CompositeFilter extends Filter {
@@ -197,7 +197,7 @@ protected DatastoreV1.Filter toPb() {
197197
}
198198
}
199199

200-
/*
200+
/**
201201
* A class representing a filter based on a single property or ancestor.
202202
*/
203203
public static final class PropertyFilter extends Filter {
@@ -520,7 +520,7 @@ static OrderBy fromPb(DatastoreV1.PropertyOrder propertyOrderPb) {
520520
}
521521
}
522522

523-
/*
523+
/**
524524
* A class representing a projection based on a property.
525525
*/
526526
public static final class Projection implements Serializable {
@@ -674,17 +674,17 @@ public B clearOrderBy() {
674674
return self();
675675
}
676676

677-
/*
678-
* Clears all previously-specified OrderBy objects and orders by the given input instead.
677+
/**
678+
* Sets the query's order by clause (clearing any previously specified OrderBy settings).
679679
*/
680680
public B orderBy(OrderBy orderBy, OrderBy... others) {
681681
clearOrderBy();
682682
addOrderBy(orderBy, others);
683683
return self();
684684
}
685685

686-
/*
687-
* Adds one or more OrderBy objects to the existing list of OrderBy objects.
686+
/**
687+
* Adds one or more order by clauses to the existing list of clauses.
688688
*/
689689
public B addOrderBy(OrderBy orderBy, OrderBy... others) {
690690
this.orderBy.add(orderBy);
@@ -697,19 +697,12 @@ B clearProjection() {
697697
return self();
698698
}
699699

700-
/*
701-
* Clears all previously-specified Projections and sets the list of Projections to the given
702-
* input instead.
703-
*/
704700
B projection(Projection projection, Projection... others) {
705701
clearProjection();
706702
addProjection(projection, others);
707703
return self();
708704
}
709705

710-
/*
711-
* Adds one or more Projections to the existing list of Projections.
712-
*/
713706
B addProjection(Projection projection, Projection... others) {
714707
this.projection.add(projection);
715708
Collections.addAll(this.projection, others);
@@ -721,19 +714,12 @@ B clearGroupBy() {
721714
return self();
722715
}
723716

724-
/*
725-
* Clears all existing properties to group by and instead groups by the given the list of
726-
* properties.
727-
*/
728717
B groupBy(String property, String... others) {
729718
clearGroupBy();
730719
addGroupBy(property, others);
731720
return self();
732721
}
733722

734-
/*
735-
* Adds one or more properties to the existing list of "group by" properties.
736-
*/
737723
B addGroupBy(String property, String... others) {
738724
this.groupBy.add(property);
739725
Collections.addAll(this.groupBy, others);
@@ -783,7 +769,7 @@ static final class Builder<V> extends BaseBuilder<V, Builder<V>> {
783769
}
784770
}
785771

786-
/*
772+
/**
787773
* A StructuredQuery builder for queries that return Entity results.
788774
*/
789775
public static final class EntityQueryBuilder extends BaseBuilder<Entity, EntityQueryBuilder> {
@@ -798,7 +784,7 @@ public StructuredQuery<Entity> build() {
798784
}
799785
}
800786

801-
/*
787+
/**
802788
* A StructuredQuery builder for queries that return Key results.
803789
*/
804790
public static final class KeyQueryBuilder extends BaseBuilder<Key, KeyQueryBuilder> {
@@ -822,7 +808,7 @@ public StructuredQuery<Key> build() {
822808
}
823809
}
824810

825-
/*
811+
/**
826812
* A StructuredQuery builder for projection queries.
827813
*/
828814
public static final class ProjectionEntityQueryBuilder
@@ -842,11 +828,17 @@ public ProjectionEntityQueryBuilder clearProjection() {
842828
return super.clearProjection();
843829
}
844830

831+
/**
832+
* Sets the query's projection clauses (clearing any previously specified Projection settings).
833+
*/
845834
@Override
846835
public ProjectionEntityQueryBuilder projection(Projection projection, Projection... others) {
847836
return super.projection(projection, others);
848837
}
849838

839+
/**
840+
* Adds one or more projection clauses to the existing list of clauses.
841+
*/
850842
@Override
851843
public ProjectionEntityQueryBuilder addProjection(Projection projection, Projection... others) {
852844
return super.addProjection(projection, others);
@@ -857,11 +849,17 @@ public ProjectionEntityQueryBuilder clearGroupBy() {
857849
return super.clearGroupBy();
858850
}
859851

852+
/**
853+
* Sets the query's group by clause (clearing any previously specified GroupBy settings).
854+
*/
860855
@Override
861856
public ProjectionEntityQueryBuilder groupBy(String property, String... others) {
862857
return super.groupBy(property, others);
863858
}
864859

860+
/**
861+
* Adds one or more properties to the existing list of group by clauses.
862+
*/
865863
@Override
866864
public ProjectionEntityQueryBuilder addGroupBy(String property, String... others) {
867865
return super.addGroupBy(property, others);

0 commit comments

Comments
 (0)