Skip to content

Broken API document formatting for Publisher and ParameterEventHandler #2607

@EwingKang

Description

@EwingKang

Bug report

Required Info:

  • Operating System:
    • N/a
  • Installation type:
    • N/a
  • Version or commit hash:
    • rolling
  • DDS implementation:
    • N/a
  • Client library (if applicable):
    • rclcpp

Steps to reproduce issue

Automatically generated documents from header files are broken in

Expected behavior

  • For the parameter_event_handler, all the example code in the comments becomes plain text in the generated html page, which is very hard to read.
  • For the publisher, the entire paragraph
    publish the LoanedMessage instance is being returned to the middleware or free’d accordingly to the allocator. If the message is not being published but processed differently, the destructor of this class will either return the message to the middleware or deallocate it via the internal allocator.
    is wrap in the see also block, with weird breaking points, and the beginning of the phrase With a call to left outside of the block. This is probably not what we want

Actual behavior

Additional information

p.s I'm not sure if this counts as a bug or feature request

Screenshots - What I saw with my browser for parameter_event_handler and publisher respectively.
image

image

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