root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity
spring-framework/src/docs/asciidoc/core.adoc

40 lines
1.4 KiB
Plaintext
Raw Normal View History

Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
[[spring-core]]
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
= Core Technologies
:doc-root: https://docs.spring.io
:api-spring-framework: {doc-root}/spring-framework/docs/{spring-version}/javadoc-api/org/springframework
Fix link references between documents Issue: SPR-14997
2017-03-29 20:20:12 +08:00
:toc: left
Use Tocbot for Table of Contents
2017-10-06 10:23:38 +08:00
:toclevels: 4
Introduce a link to go back to refdoc index
2017-09-18 18:16:47 +08:00
:docinfo1:
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
This part of the reference documentation covers all of those technologies that are
absolutely integral to the Spring Framework.
Foremost amongst these is the Spring Framework's Inversion of Control (IoC) container. A
thorough treatment of the Spring Framework's IoC container is closely followed by
comprehensive coverage of Spring's Aspect-Oriented Programming (AOP) technologies. The
Spring Framework has its own AOP framework, which is conceptually easy to understand,
and which successfully addresses the 80% sweet spot of AOP requirements in Java
enterprise programming.
Coverage of Spring's integration with AspectJ (currently the richest - in terms of
features - and certainly most mature AOP implementation in the Java enterprise space) is
also provided.
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
include::core/core-beans.adoc[leveloffset=+1]
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
include::core/core-resources.adoc[leveloffset=+1]
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
include::core/core-validation.adoc[leveloffset=+1]
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
include::core/core-expressions.adoc[leveloffset=+1]
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
include::core/core-aop.adoc[leveloffset=+1]
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Render reference documentation with Asciidoctor This commit removes docbook from the documentation toolchain and instead makes use of asciidoctor to render the reference documentation in HTML and PDF formats. The main Gradle build has been refactored with the documentation tasks and sniffer tasks extracted to their own gradle file in the "gradle" folder. A new asciidoctor Spring theme is also used to render the HTML5 backend. Issue: SPR-14997
2017-01-05 00:51:58 +08:00
include::core/core-aop-api.adoc[leveloffset=+1]
Modularize asciidoc documentation The reference documentation is now organized in asciidoc bookparts. Bookparts sections can be also put in separate files, when their size and theme are important enough to justify that. Documentation Layout: ``` index |-- overview | |-- whats-new | |-- core | |-- core-beans | |-- core-aop |-- testing | |-- data-access | |-- web | |-- web-mvc | |-- web-view |-- integration | |-- appendix |-- appx-spring-tld |-- appx-spring-form-tld ``` Supersedes and closes #641 Issue: SPR-12309
2015-03-03 18:38:01 +08:00
Revisit nullability annotations This commit introduces the following changes. 1) It adds a new Spring @NonNull annotation which allows to apply @NonNullApi semantic on a specific element, like @Nullable does. Combined with @Nullable, it allows partial null-safety support when package granularity is too broad. 2) @Nullable and @NonNull can apply to ElementType.TYPE_USE in order to be used on generic type arguments (SPR-15942). 3) Annotations does not apply to ElementType.TYPE_PARAMETER anymore since it is not supported yet (applicability for such use case is controversial and need to be discussed). 4) @NonNullApi does not apply to ElementType.FIELD anymore since in a lot of use cases (private, protected) it is not part for the public API + its usage should remain opt-in. A dedicated @NonNullFields annotation has been added in order to set fields default to non-nullable. 5) Updated Javadoc and reference documentation. Issue: SPR-15756
2017-09-15 19:26:41 +08:00
include::core/core-null-safety.adoc[leveloffset=+1]
Document DataBuffer/PooledDataBuffer and codecs Issue: SPR-16156
2017-11-03 20:27:27 +08:00
include::core/core-databuffer-codec.adoc[leveloffset=+1]
Appendix refactoring 1. Move schemas to local appendix within each top-level section. 2. Link to Javadoc for JSP tags 3. Purge Class Spring usage information Issue: SPR-16045
2017-10-05 19:23:18 +08:00
include::core/core-appendix.adoc[leveloffset=+1]