Commit Graph

66 Commits

Author SHA1 Message Date
Chris Beams
9ab2c6628b Split IoC chapter DocBook XML into multiple files (SPR-7467)
All <section/> elements in beans.xml >=~ 500 lines have been broken out
into separate documents with DOCTYPE 'section'. This refactoring makes
working with these files much easier in wysiwyg editors (namely
oXygen Author).

For consistency, this same refactoring should be applied to all other
chapters much larger than 1500 lines, such as aop.xml (3861), mvc.xml
(3466), jdbc.xml (3042), and so on.

beans.xml and the new section files have also been formatted for
consistency and to avoid whitespace diffs as much as possible into the
future.
2010-08-18 10:37:35 +00:00
Chris Beams
9a088b8128 Document BeanFactoryPostProcessor implementation constraints (SPR-7466)
JavaDoc and reference docs now warn developers against interacting with
bean instances within BeanFactoryPostProcessor implementations in order
to avoid premature bean instantiation.

See SPR-7450 for an example of a third-party BFPP
(OAuthTokenLifecycleRegistryPostProcessor) prematurely instantiating
a FactoryBean instance, such that bean post-processing is bypassed
and autowired injection (via @Inject) never occurs.
2010-08-17 09:50:22 +00:00
Chris Beams
b90260f8d2 Link to Spring Integration at end of event coverage 2010-08-11 06:36:00 +00:00
Chris Beams
3d2dd447af Remove Chapter 27 from reference documentation (SPR-7433)
Chapter 27 covered @Required and RequiredAnnotationBeanPostProcessor but
did not hold together as a chapter unto itself.  The IoC chapter already
makes mention of @Required and RequiredAnnotationBeanPostProcessor,
though not in quite as much detail as Chapter 27 did.  Links have been
updated throughout to reference these sections and Chatper 27 has been
eliminated entirely.
2010-08-10 22:13:55 +00:00
Chris Beams
abf523698c Apply parentheses consistently within <methodname/>
Prior to change, there were 175 instances of <methodname/> elements
including parentheses (e.g.: <methodname>foo()</methodname>, and
36 instances without.

Now all 211 instances include parentheses for consistency.
2010-08-10 22:13:50 +00:00
Chris Beams
9008cf907a Overhaul custom ApplicationEvent documentation (SPR-7422, SPR-7395)
Documentation now:

- Reflects generic use of ApplicationListener interface

- Demonstrates use of ApplicationEventPublisher(Aware) instead of
  ApplicationContext(Aware) for publishing custom events

- Provides a more complete narrative as to how each of the publisher,
  listener, and event objects interact with one another
2010-08-10 20:59:36 +00:00
Chris Beams
73ec840279 Remove dependency-check coverage from reference docs (SPR-7303)
- 'dependency-check' attribute of the <bean/> element was removed
  in the spring-beans-3.0 XSD; documentation now reflects this change.

- 'autodetect' was removed from the enumeration of possible values
  for autowire mode in the spring-beans-3.0 XSD; documentation now
  reflects this change.

Note that the underlying functionality for these values has not been
removed from Spring Core.  Users of Spring 3.0 who still need this
support may choose to use spring-beans-2.5.xsd in order to preserve
backward-compatibility.
2010-08-10 13:48:26 +00:00
Chris Beams
bf4b9f5ffb Replace 'Java EE' with 'enterprise Java' as appropriate
Also change 'JEE' -> 'Java EE'
2010-08-07 14:47:17 +00:00
Chris Beams
d97f899bee Fix typos (SPR-7339) 2010-08-07 13:57:23 +00:00
Chris Beams
5e64f228b6 Consistently refer to 'default no-arg constructor' (SPR-7339) 2010-08-07 13:57:12 +00:00
Michael Isvy
6adf8d18df SPR-7416
Typo on the name of the @Autowired annotation:  @Autowire -> @Autowired
Usage of the @Value annotation: ${jdbcProperties.url} -> ${jdbc.url} (inside section "Declaring @Configuration classes as plain Spring <bean/> elements").
2010-08-03 07:14:29 +00:00
Juergen Hoeller
0d405fd124 fixed typos (SPR-7332) 2010-06-29 10:22:49 +00:00
Juergen Hoeller
ecf2d8c5de fixed typos (SPR-7221) 2010-05-20 08:16:49 +00:00
Juergen Hoeller
ff4f749adb fixed typos 2010-05-16 17:32:01 +00:00
Costin Leau
42cdfbcd89 SPR-7163
SPR-7161
+ update Petclinic references
+ minor corrections
2010-05-05 13:42:46 +00:00
Costin Leau
aa216672ae SPR-7090
+ fix doc typos
2010-04-28 11:05:08 +00:00
Michael Isvy
9e5b129ba5 SPR-6885
updates based on Chris Beams' comments.
2010-02-23 15:46:52 +00:00
Michael Isvy
6af91773ee SPR-6885
Improved documentation for JavaConfig's use of CGLIB for all @Configuration annotated classes
2010-02-22 13:50:41 +00:00
Michael Isvy
c0f4d9c893 fixed SPR-6846 2010-02-15 22:45:26 +00:00
Sam Brannen
69cb15f27f [SPR-6821] Removed lingering reference to StandardScopes. 2010-02-10 21:35:26 +00:00
Costin Leau
7aec01bbac SPR-5379
+ added clarifications to section 3.4.5.2 Excluding a bean from autowiring
2010-02-09 12:23:12 +00:00
Costin Leau
a9386f5c79 SPR-5246
+ clarify order of annotation and XML injection
2010-02-09 11:17:07 +00:00
Costin Leau
dcf0244566 SPR-3786
+ add note on annotation-based injection vs XML
+ provide a nicer introduction to annotation based chapter
2010-02-01 14:36:38 +00:00
Chris Beams
1cda8cb6fa Updated documentation to point out that AnnotationConfigWebApplicationContext can accept both fully-qualified class names as well as base packages to the contextConfigLocation init-param. 2010-01-28 03:42:42 +00:00
Costin Leau
71d7b22d5e SPR-3771
+ added table summarizing the Aware interfaces in Spring 3
2010-01-26 17:02:21 +00:00
Juergen Hoeller
23b0f82173 fixed link to blog entry (SPR-6691) 2010-01-14 16:55:33 +00:00
Juergen Hoeller
4931e8b229 fixed "inner vs. nested class" terminology (SPR-6608) 2010-01-05 14:01:30 +00:00
Juergen Hoeller
f7b0a2c0a2 fixed JavaConfig sample code (SPR-6637, SPR-6638) 2010-01-05 12:58:41 +00:00
Chris Beams
d2f28ccf41 SJC-273 resolved minor @Configuration documentation error 2009-12-28 07:00:49 +00:00
Chris Beams
f6228b91e5 Resolved SPR-6187: touch-ups based on mfisher's feedback. 2009-12-16 08:44:54 +00:00
Chris Beams
0057481a0a SPR-6187: Document @Configuration classes and AnnotationConfig[Web]ApplicationContext 2009-12-15 11:04:25 +00:00
Arjen Poutsma
04e08d6952 Updated docbook files to use Docbook 4.5 DTDs, so it uses the locally cached versions 2009-12-10 15:22:55 +00:00
Mark Fisher
f6a2e58d95 SPR-6341 Added documentation for Lifecycle, SmartLifecycle, and LifecycleProcessor in the 'beans' chapter after init/destroy callbacks are covered. 2009-11-28 00:02:30 +00:00
Keith Donald
4877a0412c fixed typo 2009-11-13 19:45:57 +00:00
Luke Taylor
afe87ea881 SPR-6220: Corrected spelling of 'DataSource' 2009-11-12 16:53:06 +00:00
David Syer
46818b038a SPR-6257: Resolved in beans.xml 2009-10-27 11:56:06 +00:00
Sam Brannen
6ea83afe1e Corrected typos and cleaned up DocBook structure. 2009-10-03 23:45:23 +00:00
Mark Pollack
d8245c800b Add minimal doc for JSR 330 support. 2009-09-25 08:17:12 +00:00
Chris Beams
19bccaaa11 updates made during my review of beans.xml:
* eliminated all usage of "the section entitled", because <xref> links already render including "the section called ".  This was resulting in sentences like 'see also the section entitled the section called "@Autowired"'. This issue affected nearly all sections of the documentation, so went beyond just beans.xml

* fixed table overflow in the "Using filters to customize scanning" section (approx. p.90)

* fixed all code overflows in <programlisting/> elements

* corrected a couple minor syntax errors with SpEL examples (missing closing braces)

* added 'language="..."' element to <programlisting> elements where appropriate to enable syntax highlighting.

* normalized all code indention to four-space (some code listings were using one- and two-space)

* updated all code listings to use same-line opening braces.

* eliminated section regarding backward compatibility with Spring DTDs and singleton=true|false.  This seems like cruft to me, and we shouldn't keep historical notes around forever.

* Added <note> regarding the new thread scope (SimpleThreadScope) to Section 3.5 Bean Scopes.  Also updated the section on registering a custom Scope implementation to use the SimpleThreadScope as an example.

* updated the new-in-3.xml section to improve the @Configuration example
2009-08-31 05:36:34 +00:00
Chris Beams
b118aae971 s/(init|destroy)MethodName/(init|destroy)Method/ to reflect recent changes made when porting @Bean to Spring core. 2009-08-25 05:10:42 +00:00
Mark Pollack
3e02887dd2 SPR-5979 - Reference guide refers to non-existing type StandardScopes
SPR-5965 - Typo error in reference documentation - "What's new in Spring 3.0"
2009-08-05 19:02:55 +00:00
Mark Pollack
9696c66517 Finished applying Beverly's edits 2009-07-22 04:53:58 +00:00
Mark Pollack
35b2a7e612 Applied and reviewed Beverly's final edits up to section "beans-factory-scopes" 2009-07-16 06:41:52 +00:00
Mark Pollack
241280d24d Beverly's edits reviewed. 2009-07-16 03:17:53 +00:00
Mark Pollack
474ffaac63 Beverly's copy edits - to be reviewed. 2009-07-01 15:24:04 +00:00
Thomas Risberg
9eacd10615 removed some instances of unnecessary <value></value> elements 2009-06-26 03:37:18 +00:00
Mark Pollack
bb3c9c1898 clean up use of old <value></value> usage.
Refer to STS and p-namespace
2009-06-19 13:43:33 +00:00
Mark Pollack
7b1ff5859e minor cleanup 2009-06-16 02:37:19 +00:00
Mark Pollack
f05df17037 Remove the emphasis on BeanFactory and replace with use of ApplicationContext
Remove example of ObjectFactoryCreatingFactoryBean
Some chapter restructuring
More explicit listings of non-XML based configuration options.
2009-06-12 21:01:05 +00:00
Sam Brannen
7038e1fa3d [SPR-5824] Removed references to StandardScopes from the reference manual; updated examples accordingly; corrected typos; etc. 2009-06-12 14:29:29 +00:00