Skip to content

Documentation not being generated for parameters with type = none #266

@OscarMrZ

Description

@OscarMrZ

Hello!

From my understanding of this part of the readme:

In some cases, parameters might be unknown only at compile-time, and cannot be part of the generated C++ code. However, for documentation purpose of such parameters, the type none was introduced.

Running this command:

generate_parameter_library_markdown --input_yaml force_torque_sensor_broadcaster_parameters.yaml --output_markdown test.md

Over this parameter yaml:

force_torque_broadcaster_controller:
  sensor_name:
    type: string
    default_value: ""
    description: "Name of the sensor used as prefix for interfaces if there are no individual interface names defined."
  frame_id:
    type: string
    default_value: ""
    description: "Sensor's frame_id in which values are published."
  sensor_filter_chain:
    type: none
    description: "Map of parameters that defines a filter chain, containing filterN as key and underlying map of parameters needed for a specific filter. See <some docs> for more details."

Should yield a markdown with the documentation with the sensor_filter_chain param included. However, this doesn't seem to be the case, especially considering the implementation here.

I would just like to know if this is indeed the intended behavior. As far as my understanding goes, the only documentation for "none" parameters will be in the YAML itself. I guess this is not especially important as the parameters are normally defined elsewhere in the plugins.

Thanks a lot!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions