Page MenuHomePhabricator
Differential D5180

fix comments //!< to //!
ClosedPublic
Actions

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

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rSTAGING74d2c5fa9246: fix comments //!< to //!
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
Branch
doxycomment
Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 9302
Build 16541: Default Diff Build & Tests
Build 16540: arc lint + arc unit

Event Timeline

markblundeberg created this revision.Feb 6 2020, 14:03
Herald added a reviewer: Restricted Project. · View Herald TranscriptFeb 6 2020, 14:03
teamcity added a comment.Feb 6 2020, 14:03

Build Bitcoin-ABC / Diffs / Diff Testing started.

markblundeberg edited the summary of this revision. (Show Details)Feb 6 2020, 14:04
teamcity added a comment.Feb 6 2020, 14:08

Build Bitcoin-ABC / Diffs / Diff Testing passed.

Harbormaster completed remote builds in B9302: Diff 16076.Feb 6 2020, 14:08
Fabien accepted this revision.Feb 6 2020, 15:03
Fabien added a subscriber: Fabien.

That could be a linter

This revision is now accepted and ready to land.Feb 6 2020, 15:03
markblundeberg added a subscriber: deadalnix.Feb 7 2020, 01:09
In D5180#125121, @Fabien wrote:

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?

Closed by commit rABC74d2c5fa9246: fix comments //!< to //! (authored by Mark Lundeberg <markblundeberg@users.noreply.github.com>). · Explain WhyFeb 7 2020, 01:58
This revision was automatically updated to reflect the committed changes.
Mark Lundeberg <markblundeberg@users.noreply.github.com> added a commit: rABC74d2c5fa9246: fix comments //!< to //!.
Fabien mentioned this in D5203: [LINTER] Prevent using inline doxygen comments on their own line.Feb 7 2020, 15:29
Fabien mentioned this in rABCbb3ad402c4d5: [LINTER] Prevent using inline doxygen comments on their own line.Feb 7 2020, 16:33
Mark Lundeberg <markblundeberg@users.noreply.github.com> added a commit: rSTAGING74d2c5fa9246: fix comments //!< to //!.Apr 7 2020, 22:51
Fabien mentioned this in rSTAGINGbb3ad402c4d5: [LINTER] Prevent using inline doxygen comments on their own line.Apr 7 2020, 22:53

Revision Contents
Changeset List

PathSize
src/
14 lines
4 lines
2 lines
6 lines
4 lines
rpc/
64 lines
script/
8 lines
54 lines
util/
6 lines
2 lines
wallet/
2 lines
10 lines
2 lines
zmq/
2 lines

Diff 16076

View Options

src/blockfileinfo.h

Loading...
View Options

src/chainparams.cpp

Loading...
View Options

src/net_processing.h

Loading...
View Options

src/net_processing.cpp

Loading...
View Options

src/protocol.h

Loading...
View Options

src/rpc/protocol.h

Loading...
View Options

src/script/interpreter.cpp

Loading...
View Options

src/txmempool.h

Loading...
View Options

src/util/strencodings.h

Loading...
View Options

src/util/time.cpp

Loading...
View Options

src/wallet/db.cpp

Loading...
View Options

src/wallet/wallet.h

Loading...
View Options

src/wallet/walletdb.h

Loading...
View Options

src/zmq/zmqpublishnotifier.h

Loading...