Skip to content

Commit e19949b

Browse files
author
Kostiantyn Sologubov
committed
README corrections per review
1 parent 34e7dea commit e19949b

1 file changed

Lines changed: 4 additions & 6 deletions

File tree

utils/generator/README.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Required libraries are described in `requirements.txt` and should be pre-install
1212
```shell script
1313
python3 -m pip install -r requirements.txt
1414
```
15-
Please also make sure before usage the 'utils/generator/rpc_spec' Git submodule is successfully initialized, because the script uses the XML parser provided there.
15+
Please also make sure before usage the `utils/generator/rpc_spec` Git submodule is successfully initialized, because the script uses the XML parser provided there.
1616
```shell script
1717
git submodule update --init
1818
```
@@ -54,9 +54,7 @@ optional arguments:
5454
## Overview
5555
These are the general transformation rules for RPC classes of SDL Java Suite Library. The description of base classes, already included in the library, is not provided here, for details please view the source code.
5656
57-
The JavaDoc is used for inline documentation of generated code. All non-XML values should follow Contributing to SDL Projects [CONTRIBUTING.md](ttps://github.com/smartdevicelink/sdl_android/blob/master/.github/CONTRIBUTING.md)
58-
59-
These rules based on the current `develop` branch state (commit:`7e6a16c027bcdd0fb523a9993dc59b0171167aea`) of [`smartdevicelink/sdl_java_suite`](https://github.com/smartdevicelink/sdl_java_suite) repository.
57+
The JavaDoc is used for inline documentation of generated code. All non-XML values should follow Contributing to SDL Projects [CONTRIBUTING.md](https://github.com/smartdevicelink/sdl_android/blob/master/.github/CONTRIBUTING.md)
6058
6159
## Output Directory Structure and Package definitions
6260
@@ -71,7 +69,7 @@ According to existing structure of Java Suite the output directory will contain
7169
* `[- all <struct> classes -]`
7270
* `[- all <function> classes -]`
7371
74-
Each Enum class should be stored as a single script file in the folder named `com/smartdevicelink/rpc/enums` and the name of the script file should be equal to the value from the `"name"` attribute of `<enum>` followed by the extension `.java`. FunctionID enum generation is skipped as discussed due to high complexity of structure.
72+
Each Enum class should be stored as a single file in the folder named `com/smartdevicelink/rpc/enums` and the name of the file should be equal to the value from the `"name"` attribute of `<enum>` followed by the extension `.java`. FunctionID enum generation is skipped due to the high complexity of structure.
7573
7674
Example:
7775
```shell script
@@ -84,7 +82,7 @@ Each Enum class should include the package definition:
8482
package com.smartdevicelink.proxy.rpc.enums;
8583
```
8684
87-
Each Struct or Function class should be stored as a single script file in the folder named `com/smartdevicelink/proxy/rpc` and the name of the script file should be equal to the value from the `"name"` attribute of `<struct>` or `<function>` (followed by additional suffix `Response` if the `"name"` doesn't end with it and the `"messagetype"` attribute is set to `response`) followed by the extension `.java`.
85+
Each Struct or Function class should be stored as a single file in the folder named `com/smartdevicelink/proxy/rpc` and the name of the file should be equal to the value from the `"name"` attribute of `<struct>` or `<function>` (followed by additional suffix `Response` if the `"name"` doesn't end with it and the `"messagetype"` attribute is set to `response`) followed by the extension `.java`.
8886
8987
Example:
9088
```shell script

0 commit comments

Comments
 (0)