This is an automated email from the ASF dual-hosted git repository.
sunlan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/groovy.git
The following commit(s) were added to refs/heads/master by this push:
new e11bd61 Tweak GINQ user guide
e11bd61 is described below
commit e11bd61f1835207fbae812db350a5d6fcdea503e
Author: Daniel Sun <[email protected]>
AuthorDate: Sun Jul 25 23:24:00 2021 +0800
Tweak GINQ user guide
---
subprojects/groovy-ginq/src/spec/doc/ginq-userguide.adoc | 11 +++++++++--
1 file changed, 9 insertions(+), 2 deletions(-)
diff --git a/subprojects/groovy-ginq/src/spec/doc/ginq-userguide.adoc
b/subprojects/groovy-ginq/src/spec/doc/ginq-userguide.adoc
index e505ae1..e40c638 100644
--- a/subprojects/groovy-ginq/src/spec/doc/ginq-userguide.adoc
+++ b/subprojects/groovy-ginq/src/spec/doc/ginq-userguide.adoc
@@ -95,18 +95,25 @@ def someGinqMethod() {
}
```
For example,
+
+* Mark the `ginq` method as a GINQ method with `@GQ` annotation:
+
[source, groovy]
----
include::../test/org/apache/groovy/ginq/GinqTest.groovy[tags=ginq_method_01,indent=0]
----
-Specify the return type as `List`:
+* Specify the return type as `List`:
+
[source, groovy]
----
include::../test/org/apache/groovy/ginq/GinqTest.groovy[tags=ginq_method_03,indent=0]
----
+[NOTE]
+GINQ supports many return types, e.g. `List`, `Set`, `Collection`, `Iterable`,
`Iterator`, `java.util.stream.Stream` and array types.
+
+* Enable parallel querying:
-Enable parallel querying:
[source, groovy]
----
include::../test/org/apache/groovy/ginq/GinqTest.groovy[tags=ginq_method_02,indent=0]
