Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jonaslagoni committed Jan 4, 2024
1 parent 3df342f commit 81c3542
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
7 changes: 6 additions & 1 deletion docs/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,17 @@ Check out this [example out for a live demonstration](../examples/include-custom

One of the primary use-cases for the generated models, is to serialize and deserilize it to for example JSON, XML or binary. Each generator can have multiple ways to achieve this, and even support multiple libraries. This is achieved through presets, you can find them here for each output:

- [C++](./languages/Cplusplus.md#generate-serializer-and-deserializer-functionality)
- [C#](./languages/Csharp.md#generate-serializer-and-deserializer-functionality)
- [Dart](./languages/Dart.md#generate-serializer-and-deserializer-functionality)
- Go currently does not support this.
- [Go](./languages/Go.md#generate-serializer-and-deserializer-functionality)
- [Java](./languages/Java.md#generate-serializer-and-deserializer-functionality)
- [JavaScript](./languages/JavaScript.md#generate-serializer-and-deserializer-functionality)
- [Kotlin](./languages/Kotlin.md#generate-serializer-and-deserializer-functionality)
- [PHP](./languages/Php.md#generate-serializer-and-deserializer-functionality)
- [Python](./languages/Python.md#generate-serializer-and-deserializer-functionality)
- [Rust](./languages/Rust.md)
- [Scala](./languages/Scala.md#generate-serializer-and-deserializer-functionality)
- [TypeScript](./languages/TypeScript.md#generate-serializer-and-deserializer-functionality)

## Adapting input and outputs
Expand Down
6 changes: 5 additions & 1 deletion docs/constraints/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,18 @@ class 1name {}

There are many rules as such, but to get the full description about the default constraints here:

- [C++](./constraints/Csplusplus.md)
- [C#](./constraints/CSharp.md)
- [Dart](./constraints/Dart.md)
- [Go](./constraints/Go.md)
- [Java](./constraints/Java.md)
- [JavaScript](./constraints/JavaScript.md)
- [Kotlin](./constraints/Kotlin.md)
- [PHP](./constraints/PHP.md)
- [Python](./constraints/Python.md)
- [Rust](./constraints/Rust.md)
- [Scala](./constraints/Scala.md)
- [TypeScript](./constraints/TypeScript.md)
- [Python](./constraints/Python.md)

Even though there are many of these constraints, there might be reasons you want to customize the behavior to make it suit your use-case. Therefore each of the constraint rules can be overwritten completely and allow for you to implement your own behavior.

Expand Down
2 changes: 1 addition & 1 deletion docs/languages/Scala.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ There are special use-cases that each language supports; this document pertains

By default, descriptions are not rendered for the model; you can change that by applying `SCALA_DESCRIPTION_PRESET`.

Check out this [example for a live demonstration](../../examples/php-generate-documentation-preset).
Check out this [example for a live demonstration](../../examples/scala-generate-documentation).

## Generate serializer and deserializer functionality

Expand Down

0 comments on commit 81c3542

Please sign in to comment.