Skip to content

Documenting bitflags: how to get documentation for the generated bitflags #378

@leecbaker

Description

@leecbaker

Some code that I'm writing uses the #![warn(missing_docs)] macro to enforce a requirement that all public interfaces have documentation. I haven't been able to figure out how to generate documentation when using the bitflags! macro; I also haven't been able to turn off the linter warning using #![allow(missing_docs)].

Is there a convenient way to add doc comments to a set of flags?

  • If so, is there an example somewhere that I can reference? This would be a great thing to include in bitflags documentation.
  • If not, then take this as a feature request!

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