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
Documents maliput_malidrive xodr apps. #170
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. PTAL to my comments.
## More available options | ||
|
||
`xodr_extract` application has some available arguments that can be used. All of them can be accessed by doing `--help` | ||
|
||
`--update_linkage` : *Update road linkage information and junction id information. By default set to true.* | ||
|
||
`--output_file_path` : *Output XODR file path By default set to "./xodr_extract_output.xodr".* | ||
|
||
`--log_level`: *Sets the log output threshold; possible values are `unchanged`,`trace`, `debug`, `info`, `warn`, `err`, `critical`, `off`. By default set to `unchanged`.* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here and in the other places, there is a high chance of out-of-sync code. Do you know an if-this-then-that linter for code and documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this case(log_level), given that we are referring to a enum I could just add a reference to the enum.
`--log_level`: *Sets the log output threshold; possible values: maliput::common::logger::level. By default set to `unchanged`.*
I've been trying to find a way to "expand" that enum into the doc but I haven't found the way.
Do you know an if-this-then-that linter for code and documentation?
I couldn't find doxyen providing such a thing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's OK. Thanks for checking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Related to maliput/maliput_infrastructure#229
tutorial
folder was added to allocate tutorials for the applications.tutorials.md
file should concentrate all the tutorials