Skip to content

Commit

Permalink
fix PR comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kutluhanmetin committed Sep 26, 2023
1 parent 1db4a96 commit 29ec891
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions docs/modules/ROOT/pages/clc-serializer-generator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,20 @@ classes:
external: bool # to mark external types (external to this yaml file)
----

==== namespace:
==== namespace

Used for logical grouping of classes. Typically, for every namespace, you will have a schema file. Namespace is optional. If not provided, the classes will be generated at global namespace (no namespace). The user should provide the language specific best practice when using the namespace. The tool will use the namespace while generating code if provided.

==== imports:
==== imports

Used to import other schema files. The type definitions in the imported yaml schemas can be used within this yaml file. Cyclic imports will be checked and handled properly. For this version of the tool, an import can only be a single file name and the tool will assume all yaml files imported will be in the same directory as the importing schema file.

==== classes:
==== classes

Used to define classes in the schema.

* name
* fields
* name: Name of the class
* fields: Field specification of the class
** name: Name of the field
** type: Type of the field. Normally you should refer to another class as namespace.classname. You can use a class without namespace when the class is defined in the same schema yaml file. type can be one of the following:
*** `boolean`
Expand Down

0 comments on commit 29ec891

Please sign in to comment.