Page MenuHomePhabricator

fix comments //!< to //!
ClosedPublic

Authored by markblundeberg on Thu, Feb 6, 14:03.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABC74d2c5fa9246: fix comments //!< to //!
Summary

The style //!< is for documentation put *after* the member
being documented.
http://www.doxygen.nl/manual/docblocks.html#memberdoc

You can see how that's messing up the documentation of private
members here for example:
https://bitcoindoxygen.art/ABC/class_c_tx_mem_pool_entry.html

(Note there are still several files using //!< but correctly.)

Test Plan

ninja check all

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

markblundeberg created this revision.Thu, Feb 6, 14:03
Herald added a reviewer: Restricted Project. · View Herald TranscriptThu, Feb 6, 14:03
markblundeberg edited the summary of this revision. (Show Details)Thu, Feb 6, 14:04
Fabien accepted this revision.Thu, Feb 6, 15:03
Fabien added a subscriber: Fabien.

That could be a linter

This revision is now accepted and ready to land.Thu, Feb 6, 15:03

That could be a linter

It might be a linter's fault that it happened in the first place... @deadalnix do you remember which linter you used for D95?