Polish JavaDoc and fix doc.

neo4j · Jul 6, 2021 · 8822ba2 · 8822ba2
1 parent a578c82
commit 8822ba2
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 10 deletions.
diff --git a/docs/cypher-parser/cypher-parser.adoc b/docs/cypher-parser/cypher-parser.adoc
@@ -28,7 +28,7 @@ NOTE: The current version of the Cypher-DSL-Parser modules is rather big. This i
 <dependency>
     <groupId>{groupId}</groupId>
     <artifactId>neo4j-cypher-dsl-parser</artifactId>
-    <version>{neo4j-cypher-dsl.version}</version>
+    <version>{neo4j-cypher-dsl-version}</version>
 </dependency>
 ----
 
@@ -38,7 +38,7 @@ NOTE: The current version of the Cypher-DSL-Parser modules is rather big. This i
 .Gradle variant for additional dependencies
 ----
 dependencies {
-    implementation '{groupId}:neo4j-cypher-dsl-parser:{neo4j-cypher-dsl.version}'
+    implementation '{groupId}:neo4j-cypher-dsl-parser:{neo4j-cypher-dsl-version}'
 }
 ----
 

diff --git a/etc/checkstyle/suppressions.xml b/etc/checkstyle/suppressions.xml
@@ -4,4 +4,5 @@
     "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
 <suppressions>
     <suppress checks="RegexpHeader" files="package-info\.java"/>
+    <suppress checks="[a-zA-Z0-9]*" files="[\\/]generated-test-sources[\\/]"/>
 </suppressions>
diff --git a/neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Conditions.java b/neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Conditions.java
@@ -234,6 +234,8 @@ public static Condition isFalse() {
 	}
 
 	/**
+	 * @param symbolicName  Reference to the entity that should be checked for labels or types
+	 * @param labelsOrTypes the list of labels or types to check for
 	 * @return A condition that checks whether a node has a set of given labels or a relationship a set of given types.
 	 * @since 2021.3.0
 	 */

diff --git a/neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/RelationshipBase.java b/neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/RelationshipBase.java
@@ -82,13 +82,17 @@ private static String[] mergeTypesIfNecessary(String type, String... additionalT
 	/**
 	 * Always creates a relationship from start to end (left to right).
 	 *
-	 * @param symbolicName an optional symbolic name
-	 * @param start        start node
-	 * @param properties   The properties for the relationship
-	 * @param end          end node
-	 * @param type         type of the relationship
+	 * @param symbolicName    an optional symbolic name
+	 * @param start           start node
+	 * @param properties      The properties for the relationship
+	 * @param end             end node
+	 * @param type            type of the relationship
+	 * @param additionalTypes Additional types to be added to the relationship, only meaningfull when the object is used
+	 *                        for querying, when used in a {@literal CREATE} or {@literal MERGE} clause the runtime will
+	 *                        throw an exception.
 	 */
-	protected RelationshipBase(SymbolicName symbolicName, Node start, String type, Properties properties, Node end, String... additionalTypes) {
+	protected RelationshipBase(SymbolicName symbolicName, Node start, String type, Properties properties, Node end,
+		String... additionalTypes) {
 
 		this(symbolicName, start, Direction.LTR, properties, end, mergeTypesIfNecessary(type, additionalTypes));
 	}

diff --git a/neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Statement.java b/neo4j-cypher-dsl/src/main/java/org/neo4j/cypherdsl/core/Statement.java
@@ -80,7 +80,8 @@ static Statement of(@NotNull List<Clause> clauses) {
 	 * <p>
 	 * The {@literal USING PERIODIC HINT} is only valid right before the {@literal LOAD CSV clause}.
 	 *
-	 * @param clauses A list of clauses, must not be null
+	 * @param batchSize The batch size to pass to {@literal PERIODIC COMMIT}.
+	 * @param clauses   A list of clauses, must not be null
 	 * @return A statement
 	 * @since 2021.3.0
 	 */

diff --git a/pom.xml b/pom.xml
@@ -771,6 +771,7 @@
 						<neo4j-version>${neo4j.version}</neo4j-version>
 						<neo4j-java-driver-version>${neo4j-java-driver.version}</neo4j-java-driver-version>
 						<reactor-version>${reactor.version}</reactor-version>
+						<neo4j-cypher-dsl.version>${project.version}</neo4j-cypher-dsl.version>
 					</attributes>
 					<requires>
 						<require>asciidoctor-diagram</require>
@@ -838,7 +839,6 @@
 						<reports>
 							<report>aggregate</report>
 						</reports>
-						<configuration></configuration>
 					</reportSet>
 				</reportSets>
 			</plugin>