Skip to content

Commit

Permalink
Merge pull request #226 from ProjectMapK/org-docs
Browse files Browse the repository at this point in the history
Organize docs
  • Loading branch information
k163377 authored Mar 30, 2024
2 parents 367fe24 + 40c3993 commit 06d5964
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 11 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ First, by implementing the equivalent of https://github.com/FasterXML/jackson-mo
The cache has also been reorganized based on [benchmark results](https://github.com/ProjectMapK/kogera-benchmark) to achieve smaller memory consumption.
The performance degradation when the `strictNullChecks` option is enabled is also [greatly reduced](https://github.com/ProjectMapK/jackson-module-kogera/pull/44).

The next main feature is `value class` support.
The `jackson-module-kogera` supports many use cases for `value class`, including deserialization.
See [here](./docs/AboutValueClassSupport.md) for basic policies and notes on handling `value class`.

[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`.

## About intentional destructive changes
Expand Down
3 changes: 0 additions & 3 deletions docs/FixedIssues.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,12 @@
A list of issues that have not been resolved in `jackson-module-kotlin`, but have been or will be resolved in `kogera`.

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

## Want to fix
- [There are some problems with KNAI\.hasCreatorAnnotation · Issue \#547](https://github.com/FasterXML/jackson-module-kotlin/issues/547)
- [This module shouldn't bring kotlin\-reflect 1\.5 as a transitive dependency · Issue \#566](https://github.com/FasterXML/jackson-module-kotlin/issues/566)
4 changes: 0 additions & 4 deletions docs/KogeraSpecificImplementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,3 @@ I will consider making the classes public again when we receive requests for the
## Remove old options and `deprecated` code
Because `jackson-module-kotlin` is a framework with a long history, some old code and options remain.
In `kogera`, those options have been removed.

# Value class support
The `jackson-module-kogera` supports many use cases of `value class` (`inline class`).
This is summarized [here](./AboutValueClassSupport.md).

0 comments on commit 06d5964

Please sign in to comment.