Skip to content

drivers/dht: Worked around doxygen bug#13063

Merged
aabadie merged 1 commit intoRIOT-OS:masterfrom
maribu:dht-doc
Jan 9, 2020
Merged

drivers/dht: Worked around doxygen bug#13063
aabadie merged 1 commit intoRIOT-OS:masterfrom
maribu:dht-doc

Conversation

@maribu
Copy link
Member

@maribu maribu commented Jan 9, 2020

Contribution description

Markdown in @retval values is currently broken in Doxygen. This removes use of markdown there.

Testing procedure

Check if the generated doc for dht_read() no longer has broken @retval table

Issues/PRs references

Found in #13047


Update: Added syntax highlighting for @retval to prevent this being linked to a github user with that name.

Markdown in @RetVal values is currently broken in Doxygen. This removes use
of markdown there
@maribu maribu added Area: doc Area: Documentation Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer labels Jan 9, 2020
@maribu maribu requested a review from miri64 January 9, 2020 16:10
@miri64
Copy link
Member

miri64 commented Jan 9, 2020

Workaround for doxygen/doxygen#7499, right?

Copy link
Member

@miri64 miri64 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK, together with #13047 this results in the following—much nicer—output

image

@miri64 miri64 added the CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR label Jan 9, 2020
@maribu
Copy link
Member Author

maribu commented Jan 9, 2020

Thanks for the quick review and pointing out the issue.

(I still wonder why I missed that, even though I was looking right next to this.)

@aabadie aabadie merged commit 389c2fa into RIOT-OS:master Jan 9, 2020
@maribu maribu deleted the dht-doc branch January 9, 2020 21:29
@fjmolinas fjmolinas added this to the Release 2020.01 milestone Jan 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants