Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of "Properties" #75

Closed
erikbosch opened this issue Nov 1, 2021 · 2 comments
Closed

Documentation of "Properties" #75

erikbosch opened this issue Nov 1, 2021 · 2 comments

Comments

@erikbosch
Copy link
Contributor

Noted that we have not described "type" (i.e. attribute/sensor/actuator) in https://github.com/COVESA/vehicle_service_catalog#namespace-list-object-properties, and it is also not included in the example in the README file (but is present in the comfort seat example file).

Also noted that "arraysize" is documented, but not listed as "Optional keys".

@gunnarx
Copy link
Collaborator

gunnarx commented Aug 14, 2023

Since this is a question for the definition of the language/interface-model that is now IFEX project, the issue will be transferred from Vehicle Service Catalog project to IFEX project.

@gunnarx gunnarx transferred this issue from COVESA/vehicle_service_catalog Aug 14, 2023
@gunnar-mb
Copy link
Collaborator

  • typedef is now better described. Documentation of fields are generated from the internal model (ifex_ast.py using the ifex_ast_doc.py generator code.

it is also not included in the example in the README

Also noted that "arraysize" is documented, but not listed as "Optional keys".

Since we now have automatic generation of the documentation from the internal model, that guarantees that optionality and similar aspects are always specified correctly in the specification. We can confidently say that this has therefore been fixed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants