Spring/spring-data-neo4j
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATAGRAPH-1421 - Fix issues in the new reference documentation.

Browse Source
This commit is contained in:
Michael Simons
2020-11-03 14:34:45 +01:00
parent 9a46987702
commit cdfb0bee82
10 changed files with 42 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
pom.xml
View File

@@ -80,7 +80,7 @@
<dist.id>spring-data-neo4j</dist.id>
<dist.key>SDNEO4J</dist.key>
<flatten-maven-plugin.version>1.2.1</flatten-maven-plugin.version>
<jacoco-maven-plugin.version>0.8.5</jacoco-maven-plugin.version>
<jacoco-maven-plugin.version>0.8.6</jacoco-maven-plugin.version>
<java-module-name>spring.data.neo4j</java-module-name>
<java.version>1.8</java.version>
<jaxb.version>2.3.1</jaxb.version>
@@ -118,7 +118,7 @@
<skipUnitTests>${skipTests}</skipUnitTests>
<springdata.commons>2.4.1-SNAPSHOT</springdata.commons>
<spring-data-commons-docs.dir>../../../../../spring-data-commons/src/main/asciidoc</spring-data-commons-docs.dir>
<spring-data-commons-docs.dir>../../../../spring-data-commons/src/main/asciidoc</spring-data-commons-docs.dir>
</properties>
<dependencyManagement>
@@ -501,6 +501,19 @@
<includeTestSourceDirectory>true</includeTestSourceDirectory>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration combine.self="append">
<tags>
<tag>
<name>soundtrack</name>
<placement>X</placement>
<head>Soundtrack</head>
</tag>
</tags>
</configuration>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>

2
src/main/asciidoc/faq/faq.adoc
View File

@@ -166,7 +166,7 @@ If this is not feasible for any reason, you can either add
== How do I use Spring Expression Language in custom queries?
https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#expressions[Spring Expression Language (SpEL)] can be used in custom queries inside `:#{}`.
{spring-framework-ref}/core.html#expressions[Spring Expression Language (SpEL)] can be used in custom queries inside `:#{}`.
This is the standard Spring Data way of defining a block of text inside a query that undergoes SpEL evaluation.
The following example basically defines the same query as above, but uses a `WHERE` clause to avoid even more curly braces:

6
src/main/asciidoc/index.adoc
View File

@@ -21,10 +21,8 @@ include::{manualIncludeDir}/README.adoc[tags=properties]
:gh-base: https://github.com/spring-projects/spring-data-neo4j
:java-driver-starter-href: https://github.com/neo4j/neo4j-java-driver-spring-boot-starter
:springVersion: 5.3.0-RC1
:spring-framework-docs: https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference
:spring-framework-javadoc: https://docs.spring.io/spring/docs/{springVersion}/javadoc-api
:spring-data-commons-docs: ../../../../../spring-data-commons/src/main/asciidoc
:spring-framework-ref: https://docs.spring.io/spring/docs/{springVersion}/reference/html
:spring-data-commons-docs: ../../../../spring-data-commons/src/main/asciidoc
(C) 2008-2020 The original authors.

16
src/main/asciidoc/introduction-and-preface/building-blocks.adoc
View File

@@ -83,34 +83,34 @@ You will find it's documentation in the <<neo4j-client,appendix>>.
|`org.springframework.data.neo4j.config`
|
include::../../../main/java/org/springframework/data/neo4j/config/package-info.java[tags=intent,indent=0]
include::../../../../src/main/java/org/springframework/data/neo4j/config/package-info.java[tags=intent,indent=0]
|`org.springframework.data.neo4j.core`
|
include::../../../main/java/org/springframework/data/neo4j/core/package-info.java[tags=intent,indent=0]
include::../../../../src/main/java/org/springframework/data/neo4j/core/package-info.java[tags=intent,indent=0]
|`org.springframework.data.neo4j.core.convert`
|
include::../../../main/java/org/springframework/data/neo4j/core/convert/package-info.java[tags=intent,indent=]
include::../../../../src/main/java/org/springframework/data/neo4j/core/convert/package-info.java[tags=intent,indent=]
|`org.springframework.data.neo4j.core.support`
|
include::../../../main/java/org/springframework/data/neo4j/core/support/package-info.java[tags=intent,indent=]
include::../../../../src/main/java/org/springframework/data/neo4j/core/support/package-info.java[tags=intent,indent=]
|`org.springframework.data.neo4j.core.transaction`
|
include::../../../main/java/org/springframework/data/neo4j/core/transaction/package-info.java[tags=intent,indent=]
include::../../../../src/main/java/org/springframework/data/neo4j/core/transaction/package-info.java[tags=intent,indent=]
|`org.springframework.data.neo4j.repository`
|
include::../../../main/java/org/springframework/data/neo4j/repository/package-info.java[tags=intent,indent=0]
include::../../../../src/main/java/org/springframework/data/neo4j/repository/package-info.java[tags=intent,indent=0]
|`org.springframework.data.neo4j.repository.config`
|
include::../../../main/java/org/springframework/data/neo4j/repository/config/package-info.java[tags=intent,indent=0]
include::../../../../src/main/java/org/springframework/data/neo4j/repository/config/package-info.java[tags=intent,indent=0]
|`org.springframework.data.neo4j.repository.support`
|
include::../../../main/java/org/springframework/data/neo4j/repository/support/package-info.java[tags=intent,indent=0]
include::../../../../src/main/java/org/springframework/data/neo4j/repository/support/package-info.java[tags=intent,indent=0]
|===

8
src/main/asciidoc/introduction-and-preface/preface.adoc
View File

@@ -31,10 +31,10 @@ Here is a list of useful resources:
[[preface.spring-data]]
== Spring and Spring Data
Spring Data uses Spring Framework's https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html[core] functionality, such as the https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#beans[IoC] container,
https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#core-convert[type conversion system],
https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/core.html#expressions[expression language],
https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#jmx[JMX integration], and portable https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/data-access.html#dao-exceptions[DAO exception hierarchy].
Spring Data uses Spring Framework's {spring-framework-ref}/core.html[core] functionality, such as the {spring-framework-ref}/core.html#beans[IoC] container,
{spring-framework-ref}/core.html#core-convert[type conversion system],
{spring-framework-ref}/core.html#expressions[expression language],
{spring-framework-ref}/integration.html#jmx[JMX integration], and portable {spring-framework-ref}/data-access.html#dao-exceptions[DAO exception hierarchy].
While it is not necessary to know all the Spring APIs, understanding the concepts behind them is.
At a minimum, the idea behind IoC should be familiar.

8
src/main/java/org/springframework/data/neo4j/config/EnableNeo4jAuditing.java
View File

@@ -43,21 +43,21 @@ public @interface EnableNeo4jAuditing {
/**
* Configures the {@link AuditorAware} bean to be used to lookup the current principal.
*
* @return
* @return The name of the {@link AuditorAware} bean to be used to lookup the current principal.
*/
String auditorAwareRef() default "";
/**
* Configures whether the creation and modification dates are set. Defaults to {@literal true}.
*
* @return
* @return whether to set the creation and modification dates.
*/
boolean setDates() default true;
/**
* Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}.
*
* @return
* @return whether to mark the entity as modified on creation.
*/
boolean modifyOnCreate() default true;
@@ -65,7 +65,7 @@ public @interface EnableNeo4jAuditing {
* Configures a {@link DateTimeProvider} bean name that allows customizing actual date time class to be used for
* setting creation and modification dates.
*
* @return
* @return The name of the {@link DateTimeProvider} bean to provide the current date time for creation and modification dates.
*/
String dateTimeProviderRef() default "";
}

8
src/main/java/org/springframework/data/neo4j/config/EnableReactiveNeo4jAuditing.java
View File

@@ -43,21 +43,21 @@ public @interface EnableReactiveNeo4jAuditing {
/**
* Configures the {@link AuditorAware} bean to be used to lookup the current principal.
*
* @return
* @return The name of the {@link AuditorAware} bean to be used to lookup the current principal.
*/
String auditorAwareRef() default "";
/**
* Configures whether the creation and modification dates are set. Defaults to {@literal true}.
*
* @return
* @return whether to set the creation and modification dates.
*/
boolean setDates() default true;
/**
* Configures whether the entity shall be marked as modified on creation. Defaults to {@literal true}.
*
* @return
* @return whether to mark the entity as modified on creation.
*/
boolean modifyOnCreate() default true;
@@ -65,7 +65,7 @@ public @interface EnableReactiveNeo4jAuditing {
* Configures a {@link DateTimeProvider} bean name that allows customizing actual date time class to be used for
* setting creation and modification dates.
*
* @return
* @return The name of the {@link DateTimeProvider} bean to provide the current date time for creation and modification dates.
*/
String dateTimeProviderRef() default "";
}

4
src/main/java/org/springframework/data/neo4j/core/convert/Neo4jPersistentPropertyConverter.java
View File

@@ -31,13 +31,13 @@ public interface Neo4jPersistentPropertyConverter<T> {
/**
* @param source The value to store, never null.
* @return
* @return The converted value, never null.
*/
Value write(T source);
/**
* @param source The value to read, never null or {@link org.neo4j.driver.Values#NULL}
* @return
* @return The converted value, maybe null if {@code source} was equals to {@link org.neo4j.driver.Values#NULL}.
*/
T read(Value source);
}

2
src/main/java/org/springframework/data/neo4j/repository/query/CypherAdapterUtils.java
View File

@@ -39,7 +39,7 @@ import org.springframework.data.neo4j.core.mapping.NodeDescription;
public final class CypherAdapterUtils {
/**
* Maps Spring Datas {@link Sort.Order} to a {@link SortItem}. See {@link #toSortItems(NodeDescription, Sort)}.
* Maps Spring Datas {@link org.springframework.data.domain.Sort.Order} to a {@link SortItem}. See {@link #toSortItems(NodeDescription, Sort)}.
*
* @param nodeDescription {@link NodeDescription} to get properties for sorting from.
* @return A stream if sort items. Will be empty when sort is unsorted.

2
src/main/java/org/springframework/data/neo4j/repository/support/ReactivePersistenceExceptionTranslationPostProcessor.java
View File

@@ -40,7 +40,7 @@ import org.springframework.util.Assert;
* Bean post-processor that automatically applies persistence exception translation to all methods returning either
* {@link reactor.core.publisher.Mono} or {@link reactor.core.publisher.Flux} of any bean marked with
* Spring's @{@link Repository Repository} annotation, adding a corresponding
* {@link ReactivePersistenceExceptionTranslationAdvisor} to the exposed proxy (either an existing AOP proxy or a newly
* {@link AbstractPointcutAdvisor} to the exposed proxy (either an existing AOP proxy or a newly
* generated proxy that implements all of the target's interfaces).
* <p>
* That proxy will modify the reactive types by the matched method and inject an exception translation into the reactive