Skip to content

Extraneous leading lower-than character (<) in after-member comment syntax #3172

Open
@Enet4

Description

@Enet4

Context

Some C code may declare doc comments in the same line as the respective member with a special syntax for the effect.

enum ColorSpace {
    RGB = 0, /**< red green blue */
    YBR_FULL, /**< YCbCr, full chrominance */
    XYB = 2 /**< LMS XYB */
};

This seems to be correctly interpreted, as bindgen is associating these comment blocks with the correct item. Removing < from the input would have resulted in the comments being linked to the subsequent item. However, the leading < character is retained in the Rust doc comment.

/* automatically generated by rust-bindgen 0.71.1 */

#[doc = "< red green blue"]
pub const ColorSpace_RGB: ColorSpace = 0;
#[doc = "< YCbCr, full chrominance"]
pub const ColorSpace_YBR_FULL: ColorSpace = 1;
#[doc = "< LMS XYB"]
pub const ColorSpace_XYB: ColorSpace = 2;
pub type ColorSpace = ::std::os::raw::c_uint;

Expected behavior

Since the < is part of the comment syntax, it should not be included in the doc string.

/* automatically generated by rust-bindgen 0.71.1 */

#[doc = "red green blue"]
pub const ColorSpace_RGB: ColorSpace = 0;
#[doc = "YCbCr, full chrominance"]
pub const ColorSpace_YBR_FULL: ColorSpace = 1;
#[doc = "LMS XYB"]
pub const ColorSpace_XYB: ColorSpace = 2;
pub type ColorSpace = ::std::os::raw::c_uint;

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