Skip to content

The auto-generated documentation is hardly readable. #11

@UncleRus

Description

@UncleRus

The issue

The code comments should be revised so that they are not only easy to read when viewing the header files, but also remain clear and understandable to users after processing the source code with Doxygen and Sphinx.

How it looks now:
Image

Which SDK are you using?

esp-idf

Which version of SDK are you using?

Which build target have you used?

  • esp32
  • esp32s2
  • esp32s3
  • esp32c2
  • esp32c5
  • esp32c6
  • esp32c61
  • esp32h2
  • esp32p4
  • esp8266
  • other

Component causing the issue

i2cdev

Anything in the logs that might be useful for us?

Additional information or context

No response

Confirmation

  • This report is not a question nor a request for drivers.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions