Page MenuHomePhabricator
Differential D8425

Fix improper Doxygen inline comments
ClosedPublic
Actions

Authored by PiRK on Nov 16 2020, 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

Event Timeline

PiRK created this revision.Nov 16 2020, 15:21
Herald added a reviewer: Restricted Project. · View Herald TranscriptNov 16 2020, 15:21
PiRK requested review of this revision.Nov 16 2020, 15:21
teamcity edited the summary of this revision. (Show Details)Nov 16 2020, 15:22
PiRK added a comment.Nov 16 2020, 15:24

Or should I place the comment on the line above?

majcosta requested changes to this revision.Nov 16 2020, 15:33
majcosta added a subscriber: majcosta.
majcosta added inline comments.
src/util/settings.h
97

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.Nov 16 2020, 15:33
Harbormaster completed remote builds in B14062: Diff 25791.Nov 16 2020, 15:34
PiRK updated this revision to Diff 25796.Nov 16 2020, 18:38

put comments on their own line

Harbormaster completed remote builds in B14065: Diff 25796.Nov 16 2020, 18:50
deadalnix accepted this revision.Nov 16 2020, 21:07
majcosta accepted this revision.Nov 17 2020, 01:19
This revision is now accepted and ready to land.Nov 17 2020, 01:19
PiRK edited the summary of this revision. (Show Details)Nov 17 2020, 08:06
Closed by commit rABCf5dd9ee879ff: Fix improper Doxygen inline comments (authored by Ben Woosley <ben.woosley@gmail.com>, committed by PiRK). · Explain WhyNov 17 2020, 09:29
This revision was automatically updated to reflect the committed changes.
PiRK added a commit: rABCf5dd9ee879ff: Fix improper Doxygen inline comments.

Revision Contents
Changeset List

PathSize
src/
util/
10 lines

Diff 25791

View Options

src/util/settings.h

Loading...