Skip to content

doxygen: Fix member comments - #14331

Merged
maflcko merged 1 commit into
bitcoin:masterfrom
maflcko:Mf1809-doxygenMembers
Oct 1, 2018
Merged

maflcko merged 1 commit into
bitcoin:masterfrom
maflcko:Mf1809-doxygenMembers

Conversation

@maflcko

@maflcko maflcko commented Sep 26, 2018

Copy link
Copy Markdown
Member

Trailing comments must be indicted with the caret //!<.

Not all places do this right now, see for example https://dev.visucore.com/bitcoin/doxygen/txmempool_8h.html#a2bc6653552b5871101b6cbefdbaf251f, but they can be fixed with an almost-scripted-diff:

sed -i --regexp-extended -e 's/((,|;) *\/\/!) /\1< /g' $(git grep --extended-regexp -l  '(,|;)\s*//!\s')

(Same as [doxygen] Fix member comments #7793)

@maflcko maflcko added the Docs label Sep 26, 2018
@DrahtBot

DrahtBot commented Sep 26, 2018 •

Copy link
Copy Markdown
Contributor
Reviewers, this pull request conflicts with the following ones:

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@jamesob

jamesob commented Sep 27, 2018

Copy link
Copy Markdown
Contributor

utACK fa69ac7

@l2a5b1

l2a5b1 commented Sep 27, 2018

Copy link
Copy Markdown
Contributor

utACK fa69ac7

1 similar comment
@Empact

Empact commented Sep 27, 2018

Copy link
Copy Markdown
Contributor

utACK fa69ac7

@DrahtBot

Copy link
Copy Markdown
Contributor
Coverage Change (pull 14331) Reference (master)
Lines -0.0309 % 87.0361 %
Functions +0.0926 % 84.1130 %
Branches -0.0445 % 51.5451 %

@promag

promag commented Sep 29, 2018

Copy link
Copy Markdown
Contributor

utACK fa69ac7.

maflcko pushed a commit to maflcko/bitcoin-core that referenced this pull request Oct 1, 2018
fa69ac7 doxygen: Fix member comments (MarcoFalke)

Pull request description:

  Trailing comments must be indicted with the caret `//!<`.

  Not all places do this right now, see for example https://dev.visucore.com/bitcoin/doxygen/txmempool_8h.html#a2bc6653552b5871101b6cbefdbaf251f, but they can be fixed with an almost-scripted-diff:

  ```
  sed -i --regexp-extended -e 's/((,|;) *\/\/!) /\1< /g' $(git grep --extended-regexp -l  '(,|;)\s*//!\s')
  ```

  (Same as  [doxygen] Fix member comments bitcoin#7793)

Tree-SHA512: 451077008353ccc6fcc795f34094b2d022feb7a171b562a07ba4de0dcb0aebc137e12b03970764bd81e2da386751d042903db4c4831900f43c0cfde804c81b2b
@maflcko
maflcko merged commit fa69ac7 into bitcoin:master Oct 1, 2018
@maflcko
maflcko deleted the Mf1809-doxygenMembers branch October 1, 2018 01:18
jasonbcox pushed a commit to Bitcoin-ABC/bitcoin-abc that referenced this pull request Oct 11, 2019
Summary:
Trailing comments must be indicted with the caret `//!<`.

Backport of Bitcoin Core PR14331
bitcoin/bitcoin#14331

Test Plan:
```
doxygen doc/Doxyfile
```

Reviewers: Fabien, #bitcoin_abc, deadalnix, jasonbcox

Reviewed By: #bitcoin_abc, jasonbcox

Subscribers: jasonbcox

Differential Revision: https://reviews.bitcoinabc.org/D4173
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Aug 16, 2021
fa69ac7 doxygen: Fix member comments (MarcoFalke)

Pull request description:

  Trailing comments must be indicted with the caret `//!<`.

  Not all places do this right now, see for example https://dev.visucore.com/bitcoin/doxygen/txmempool_8h.html#a2bc6653552b5871101b6cbefdbaf251f, but they can be fixed with an almost-scripted-diff:

  ```
  sed -i --regexp-extended -e 's/((,|;) *\/\/!) /\1< /g' $(git grep --extended-regexp -l  '(,|;)\s*//!\s')
  ```

  (Same as  [doxygen] Fix member comments dashpay#7793)

Tree-SHA512: 451077008353ccc6fcc795f34094b2d022feb7a171b562a07ba4de0dcb0aebc137e12b03970764bd81e2da386751d042903db4c4831900f43c0cfde804c81b2b
PastaPastaPasta pushed a commit to PastaPastaPasta/dash that referenced this pull request Aug 18, 2021
fa69ac7 doxygen: Fix member comments (MarcoFalke)

Pull request description:

  Trailing comments must be indicted with the caret `//!<`.

  Not all places do this right now, see for example https://dev.visucore.com/bitcoin/doxygen/txmempool_8h.html#a2bc6653552b5871101b6cbefdbaf251f, but they can be fixed with an almost-scripted-diff:

  ```
  sed -i --regexp-extended -e 's/((,|;) *\/\/!) /\1< /g' $(git grep --extended-regexp -l  '(,|;)\s*//!\s')
  ```

  (Same as  [doxygen] Fix member comments dashpay#7793)

Tree-SHA512: 451077008353ccc6fcc795f34094b2d022feb7a171b562a07ba4de0dcb0aebc137e12b03970764bd81e2da386751d042903db4c4831900f43c0cfde804c81b2b
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants