Page MenuHomePhabricator

Fix improper Doxygen inline comments
ClosedPublic

Authored by PiRK on Mon, Nov 16, 15:21.

Details

Reviewers
majcosta
deadalnix
Group Reviewers
Restricted Project
Commits
rABCf5dd9ee879ff: Fix improper Doxygen inline comments
Summary

The proper syntax for same line doxygen-comments is "//!<", but we prefer comments to be on the previous line.
http://www.doxygen.nl/manual/docblocks.html#memberdoc

This is a backport of Core PR17907

Test Plan

ninja doc-doxygen && firefox doc/doxygen/html/structutil_1_1_settings_span.html

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

PiRK requested review of this revision.Mon, Nov 16, 15:21

Or should I place the comment on the line above?

majcosta requested changes to this revision.Mon, Nov 16, 15:33
majcosta added a subscriber: majcosta.
majcosta added inline comments.
src/util/settings.h
97 ↗(On Diff #25791)

put comments on their own lines, I think doxygen looks like below, if not linter will tell you:

//! Pointer to first non-negated value.
const SettingsValue *begin() const;
//! Pointer to end of values.
const SettingsValue *end() const;
[etc]
This revision now requires changes to proceed.Mon, Nov 16, 15:33

put comments on their own line

This revision is now accepted and ready to land.Tue, Nov 17, 01:19
This revision was automatically updated to reflect the committed changes.