Skip to content

Commit 2925009

Browse files
authored
docs: add release notes section to README and clarify versioning (#311)
1 parent 573e568 commit 2925009

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,15 @@ Project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LI
2222

2323
-----
2424

25+
## Release notes
26+
27+
Release notes for this component/repo are available in [Jackson Releases](https://github.com/FasterXML/jackson/wiki/Jackson-Releases) page (unified for all official Jackson components).
28+
29+
NOTE: Annotations module is released with "simple" version like 2.20 without "patch" number -- except for rare case of critical fixes.
30+
This change occurred with Jackson 2.20: prior to it, patch number was included but was meaningless: every patch version of a minor release was identical.
31+
32+
NOTE: Jackson 3.x components rely on 2.x annotations; there are no separate 3.x `jackson-annotations` versions released (there were RC versions up to 3.0-rc5 but not after that).
33+
2534
## Usage, general
2635

2736
### Improvements over typical Java annotations
@@ -221,9 +230,9 @@ Note that `@JsonTypeInfo` has lots of configuration possibilities: for more info
221230

222231
The default Jackson property detection rules will find:
223232

224-
* All ''public'' fields
225-
* All ''public'' getters ('getXxx()' methods)
226-
* All setters ('setXxx(value)' methods), ''regardless of visibility'')
233+
* All `public` fields
234+
* All `public` getters (`getXxx()` methods)
235+
* All setters (`setXxx(value)` methods), **regardless of visibility**)
227236

228237
But if this does not work, you can change visibility levels by using annotation `@JsonAutoDetect`.
229238
If you wanted, for example, to auto-detect ALL fields (similar to how packages like GSON work), you could do:

0 commit comments

Comments
 (0)