Commit Graph

1176 Commits

Author SHA1 Message Date
Sebastien Deleuze 6c4a103f70 Remove support for generics nullability for now
See https://github.com/Kotlin/KEEP/issues/79
2017-09-21 18:44:27 +02:00
Juergen Hoeller ffe80ff002 Clarify @Bean return type recommendation in case of multiple interfaces
Issue: SPR-15973
2017-09-20 10:54:23 +02:00
Sebastien Deleuze 8caeb33974 Polish Kotlin reference documentation 2017-09-19 13:34:21 +02:00
Sebastien Deleuze 825449a3d2 Introduce a link to go back to refdoc index 2017-09-18 15:23:26 +02:00
Sebastien Deleuze c5ba55ffc2 Polish null-safety documentation
Issue: SPR-15756
2017-09-15 18:06:58 +02:00
Sebastien Deleuze 1bc93e3d0f 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 13:26:41 +02:00
Rossen Stoyanchev ac5694b150 Web documentation update
Issue: SPR-15149
2017-09-12 15:02:00 -04:00
David Harrigan 1871c9626d Kotlin documentation readability improvements
Issue: SPR-15659
2017-09-12 16:36:06 +02:00
Rossen Stoyanchev 5c0ca98372 Update index.adoc 2017-09-09 18:21:57 -04:00
Sebastien Deleuze a8693bf947 Improve Kotlin ref doc
This commit add a section about annotations and provides
various update and enhancements to the Kotlin reference
documentation.

Issue: SPR-15659
2017-09-07 17:30:52 +02:00
Sam Brannen dcdb0b416f Rename SPRING_CLASS_RULE fields to springClassRule 2017-09-06 17:38:22 +02:00
Sebastien Deleuze 699dfc55a8 Improve Kotlin ref doc structure
Issue: SPR-15659
2017-09-06 17:13:17 +02:00
Sebastien Deleuze 5ae35f606c Leverage kotlin-reflect to determine parameter names
This is especially useful to determine interface parameter names
without requiring Java 8 -parameters compiler flag.

Issue: SPR-15541
2017-09-06 15:56:45 +02:00
Sebastien Deleuze 60f763a0dd Polish Kotlin reference documentation
Issue: SPR-15659
2017-09-04 10:54:48 +02:00
Sebastien Deleuze 2969af82d2 Fix Reactive Web link in the ref doc 2017-09-04 07:40:18 +02:00
Arend v. Reinersdorff ba50581961 Minor fix in example code: No quotes for boolean
Closes gh-1511
2017-09-01 09:26:47 +02:00
Sebastien Deleuze 2f812112c2 Update Kotlin Slack URL
Issue: SPR-15659
2017-08-31 10:23:25 +02:00
Sebastien Deleuze 466699ba63 Polishing
Issue: SPR-15659
2017-08-31 09:57:11 +02:00
Sebastien Deleuze 44e8cdcd89 Polishing
Issue: SPR-15659
2017-08-30 17:28:36 +02:00
Sebastien Deleuze 884fc40c3c Add "Injecting configuration properties" to Kotlin ref doc
Issue: SPR-15659
2017-08-30 16:36:55 +02:00
Sebastien Deleuze 3c9bb645d5 Improve Kotlin reference documentation
Issue: SPR-15659
2017-08-30 11:56:20 +02:00
Sebastien Deleuze bddd71e705 Polishing
Issue: SPR-15659
2017-08-29 10:45:11 +02:00
Sebastien Deleuze 4359008b2b Polishing
Issue: SPR-15659
2017-08-29 01:49:37 +02:00
Sebastien Deleuze c1559b3f0a Fix link to Spring Framework KDoc
Issue: SPR-15659
2017-08-29 01:43:32 +02:00
Sebastien Deleuze ed6a35b465 Add API and reference documentation for Kotlin support
Issue: SPR-15659
2017-08-29 01:07:27 +02:00
Sebastien Deleuze ba02b5761e Provide distinct Web and Reactive Web sections
This change allows much more usable TOC for the reactive
stack and will make WebFlux documentation easier to
contribute thanks to a clearer split between both stacks.

Issue: SPR-15149
2017-08-23 16:02:04 +02:00
Sebastien Deleuze cdb6688815 Update WebFlux code examples 2017-08-23 13:59:46 +02:00
Sebastien Deleuze d61db48d64 Improve WebFlux documentation sections
Issue: SPR-15149
2017-08-23 13:53:58 +02:00
Stephane Nicoll 3d28e80e53 Fix code format
Closes gh-1501
2017-08-21 08:42:26 +02:00
Rossen Stoyanchev dabb02d830 Update docs on DispatcherServlet config and processing
Issue: SPR-15149
2017-08-18 19:07:28 +02:00
Rossen Stoyanchev 940a344a73 Polish 2017-08-18 19:07:28 +02:00
Rossen Stoyanchev 18f42f9667 Fix typo
Issue: SPR-15872
2017-08-18 09:18:03 +02:00
Rossen Stoyanchev 10dcaa9bf6 Update introduction to Spring Web MVC
Issue: SPR-15149
2017-08-17 21:59:19 +02:00
Rossen Stoyanchev 11ac87099a Prepare Web section for Servlet vs Reactive content
Refer to both Servlet and reactive stacks in web.adoc
Move web-integration.adoc to the very end
Link in web-flux-functional.adoc
Insert "Spring Web MVC" or "Servlet" prefix in chapter titles

Issue: SPR-15149
2017-08-17 21:59:13 +02:00
Rossen Stoyanchev f1b017af04 Insert line breaks 2017-08-17 21:58:41 +02:00
Rossen Stoyanchev 181f002ddf Use exact type name in doc sample
Issue: SPR-15863
2017-08-15 14:44:22 +02:00
Rossen Stoyanchev e45733e790 Update overview.adoc 2017-07-28 17:20:19 +02:00
Rossen Stoyanchev d37498c354 Update overview.adoc 2017-07-28 16:37:49 +02:00
Rossen Stoyanchev a48a47bbd0 Merge pull request #1487 from Buzzardo/master
New overview
2017-07-28 16:18:34 +02:00
Jay Bryant 4872084079 New overview
We have written a replacement for the current overview, as the beginning of a larger documentation effort.
2017-07-28 08:38:38 -05:00
Stephane Nicoll 19c88f2cfa Polish components indexer doc
Issue: SPR-15793
2017-07-19 10:05:09 +02:00
Rossen Stoyanchev e37af83459 Improve docs on on use of urlDecode=false
Issue: SPR-15643
2017-07-14 16:52:02 +02:00
Rossen Stoyanchev 134ceac58e Set all strategies in CNM factory bean
ContentNegotiationManagerFactoryBean now provides an option to
explicitly set the strategies to use vs customizing a fixed
list of default strategies.

Issue: SPR-11114
2017-07-11 21:00:57 +02:00
Brian Clozel f63b0d720e Update WebFlux reference documentation
Note that WebFlux and WebFlux.fn can be both used at the same time
thanks to the handler mapping registration in `@EnableWebFlux`.

Fixing typos in the reference documentation for outdated Reactor
operators.
2017-07-04 13:47:05 +02:00
freeman0432 b14df2b6ea Fix a missing line of xml fragment
Closes gh-1461
2017-06-17 10:33:08 +02:00
Rossen Stoyanchev 4d52590964 Improve docs on forwarded headers
Issue: SPR-15612
2017-06-01 22:36:12 -04:00
Kazuki Shimizu 1412c2c577 Fix sample code in WebFlux chapter 2017-05-31 22:05:38 -04:00
Sam Brannen 76b28a0cec Fix grammatical errors in Testing chapter 2017-05-28 14:28:57 +02:00
Violeta Georgieva 7f616c216b Specify the HandlerMapping#order in the websocket example
The order value has to be specified for the HandlerMapping
so that it will be ordered before the one that serves the static resource.
2017-05-12 20:45:27 +03:00
Juergen Hoeller 4d86515fa5 Overridable Commons Logging bridge in separate spring-jcl jar
Issue: SPR-14512
2017-05-03 20:29:05 +02:00
Sam Brannen 55833dc3d1 Discontinue use of Rouge in the Reference Manual
Due to a bug in Rouge thats prevents it from working on MS Windows, we
are currently reverting back to CodeRay for source code highlighting
within the Reference Manual.

Issues: SPR-15471
2017-04-22 19:02:46 +02:00
Rossen Stoyanchev 7df3d68b2a Replace WebMvcConfigurerAdapter with default methods
Issue: SPR-15465
2017-04-20 16:14:13 -04:00
Fredrik Sundberg cf50a9a1ed Fix Selenium links in testing.adoc
Selenium wiki & javadoc moved from google code to github.
Also a fix to a link for Geb.

Closes gh-1392
2017-04-19 09:22:35 +02:00
Stephane Nicoll 1c0b3be6e6 Customize QosSettings for JMS replies
This commit introduces QosSettings that gather the Qualify of Service
settings one can use when sending a message. Such object can now be
associated to any JMS endpoint that allows to send a reply as part of
the processing of an incoming message.

Issue: SPR-15408
2017-04-18 13:15:38 +02:00
Juergen Hoeller a49a0007b2 Revised overview (aligned with the 4.3.x line) 2017-04-17 19:55:45 +02:00
Juergen Hoeller 5d3249f692 Recommendation for consistent @Profile declarations on overloaded @Bean methods
Issue: SPR-15266
2017-04-17 14:52:06 +02:00
Juergen Hoeller 022aefdfe8 Explicit note about @Profile declarations on overloaded @Bean methods
Also marks @Conditional as @Documented, aligned with other annotations.

Issue: SPR-15266
2017-04-15 14:17:45 +02:00
Juergen Hoeller d50dab6ea9 Suppress deprecation warning on JDK 9 (for LogRecord.setMillis)
Includes revised Log methods in log level order, with consistent delegation of fatal->error for log level checks in SLF4J and JUL, a JavaUtilDelegate for defensive access to java.logging on JDK 9, support for LogRecord message objects, as well as revised log setup recommendations.

Issue: SPR-15453
Issue: SPR-14512
2017-04-14 22:43:44 +02:00
Brian Clozel bf3fe93dbd Do not mention deprecated Reactive Boot starter
There's an officially supported Spring WebFlux starter now in Spring
Boot, so all mentions to the experimental starter are now removed.
2017-04-14 19:22:46 +02:00
Brian Clozel a8d785b87f Move RxNetty support to test scope
The RxNetty runtime support is not meant to be officially supported and
should be restricted to testing purposes only.

Issue: SPR-15444
2017-04-14 19:18:42 +02:00
Stephane Nicoll 7084bc293a Polish "Improve unless condition in caching doc"
Closes gh-1387
2017-04-13 17:50:11 +02:00
Michael J. Simons b426d847e6 Improve unless condition in caching doc
See gh-1387
2017-04-13 17:48:00 +02:00
Michael J. Simons 33fd94c098 Polish condition in caching examples
Closes gh-1386
2017-04-13 17:45:03 +02:00
Sebastien Deleuze dce72e0ad0 Change Mono#then to Mono#flatMap in documentation
Issue: SPR-15318
2017-04-13 15:37:27 +02:00
Sebastien Deleuze e3fae2716e Rename Mono#otherwise[Empty] to switch[onError/IfEmpty]
Issue: SPR-15318
2017-04-13 15:36:34 +02:00
Kirill Gavrilov 5fd03e45f6 Fix typo
Closes gh-1383
2017-04-10 09:53:52 +02:00
Rossen Stoyanchev e4c62cc029 Controller API for view rendering
Issue: SPR-15211
2017-04-07 17:15:07 -04:00
Sam Brannen f3ec812abf Delete obsolete GIF and JPG images
This commit deletes images that are no longer used in the Reference
Manual.

Issue: SPR-14997
2017-04-06 18:14:11 +02:00
Sam Brannen 3a4b205b20 Use Rouge syntax highlighting in PDF version of Reference Manual
This commit uses a tip provided by @mojavelinux to set the syntax
highlighter to Rouge for the PDF version of the User Guide.

Once Asciidoctor 1.5.7 has been released we will likely switch to Rouge
for the HTML version of the Reference Manual as well.

Issue: SPR-14997
2017-04-06 18:07:19 +02:00
Sam Brannen b403fb3749 Fix grammar 2017-04-06 17:47:13 +02:00
Sam Brannen ffa5dbe898 Polishing 2017-04-05 18:21:22 +02:00
Sam Brannen 454e61e8ac Use standard PNGs in reference manual
This commit converts interlaced PNGs to standard PNGs and uses PNGs
instead of GIFs consistently within the reference manual in order to
avoid issues with AsciiDoc’s support for inlined images.

Issue: SPR-14997
2017-04-05 00:09:54 +02:00
Rossen Stoyanchev c7c480610c Polish doc changes 2017-04-04 17:44:57 -04:00
Rossen Stoyanchev f293c4d84b Doc use of reactive types in Spring MVC controllers
Issue: SPR-15365
2017-04-04 17:32:24 -04:00
Brian Clozel dea4825a9f Fix link references between documents
Issue: SPR-14997
2017-03-29 14:22:46 +02:00
Brian Clozel 924adaec6c 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-03-29 14:22:46 +02:00