Skip to content

Commit 06d5964

Browse files
authored
Merge pull request #226 from ProjectMapK/org-docs
Organize docs
2 parents 367fe24 + 40c3993 commit 06d5964

File tree

3 files changed

+0
-11
lines changed

3 files changed

+0
-11
lines changed

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,6 @@ First, by implementing the equivalent of https://github.com/FasterXML/jackson-mo
2323
The cache has also been reorganized based on [benchmark results](https://github.com/ProjectMapK/kogera-benchmark) to achieve smaller memory consumption.
2424
The performance degradation when the `strictNullChecks` option is enabled is also [greatly reduced](https://github.com/ProjectMapK/jackson-module-kogera/pull/44).
2525

26-
The next main feature is `value class` support.
27-
The `jackson-module-kogera` supports many use cases for `value class`, including deserialization.
28-
See [here](./docs/AboutValueClassSupport.md) for basic policies and notes on handling `value class`.
29-
3026
[Here](./docs/FixedIssues.md) is a list of issues that are not resolved in `jackson-module-kotlin` but are or will be resolved in `kogera`.
3127

3228
## About intentional destructive changes

docs/FixedIssues.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
A list of issues that have not been resolved in `jackson-module-kotlin`, but have been or will be resolved in `kogera`.
22

33
## Fixed
4-
- [Support for inline classes · Issue \#199](https://github.com/FasterXML/jackson-module-kotlin/issues/199)
54
- [Getting MismatchedInputException instead of MissingKotlinParameterException · Issue \#234](https://github.com/FasterXML/jackson-module-kotlin/issues/234)
65
- [Private getter with different return type hides property · Issue \#341](https://github.com/FasterXML/jackson-module-kotlin/issues/341)
76
- [Remove \`kotlin\-reflect\` and replace it with \`kotlinx\-metadata\-jvm\` · Issue \#450](https://github.com/FasterXML/jackson-module-kotlin/issues/450)
8-
- [Supports deserialization of \`value class\` \(\`inline class\`\)\. · Issue \#650](https://github.com/FasterXML/jackson-module-kotlin/issues/650)
97
- [Annotation given to constructor parameters containing \`value class\` as argument does not work · Issue \#651](https://github.com/FasterXML/jackson-module-kotlin/issues/651)
108
- [How to deserialize a kotlin\.ranges\.ClosedRange<T> with Jackson · Issue \#663](https://github.com/FasterXML/jackson-module-kotlin/issues/663)
119
- [There are cases where \`isRequired\` specifications are not properly merged\. · Issue \#668](https://github.com/FasterXML/jackson-module-kotlin/issues/668)
1210

1311
## Want to fix
1412
- [There are some problems with KNAI\.hasCreatorAnnotation · Issue \#547](https://github.com/FasterXML/jackson-module-kotlin/issues/547)
15-
- [This module shouldn't bring kotlin\-reflect 1\.5 as a transitive dependency · Issue \#566](https://github.com/FasterXML/jackson-module-kotlin/issues/566)

docs/KogeraSpecificImplementations.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,3 @@ I will consider making the classes public again when we receive requests for the
2525
## Remove old options and `deprecated` code
2626
Because `jackson-module-kotlin` is a framework with a long history, some old code and options remain.
2727
In `kogera`, those options have been removed.
28-
29-
# Value class support
30-
The `jackson-module-kogera` supports many use cases of `value class` (`inline class`).
31-
This is summarized [here](./AboutValueClassSupport.md).

0 commit comments

Comments
 (0)