doc: Fix improper Doxygen inline comments #17907

pull Empact wants to merge 1 commits into bitcoin:master from Empact:settings-documentation changing 1 files +5 −5
  1. Empact commented at 12:33 AM on January 11, 2020: member

    The proper syntax is //!< http://www.doxygen.nl/manual/docblocks.html#memberdoc

    Identified via -Wdocumentation:

    In file included from ./util/system.h:26:
    ./util/settings.h:74:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
        const SettingsValue* begin() const; //<! Pointer to first non-negated value.
                                            ^~~~
                                            ///<
    ./util/settings.h:75:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
        const SettingsValue* end() const;   //<! Pointer to end of values.
                                            ^~~~
                                            ///<
    ./util/settings.h:76:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
        bool empty() const;                 //<! True if there are any non-negated values.
                                            ^~~~
                                            ///<
    ./util/settings.h:77:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
        bool last_negated() const;          //<! True if the last value is negated.
                                            ^~~~
                                            ///<
    ./util/settings.h:78:41: error: not a Doxygen trailing comment [-Werror,-Wdocumentation]
        size_t negated() const;             //<! Number of negated values.
                                            ^~~~
                                            ///<
    
  2. Fix improper Doxygen inline comments
    The proper syntax is "//!<"
    http://www.doxygen.nl/manual/docblocks.html#memberdoc
    498cdbb426
  3. fanquake added the label Docs on Jan 11, 2020
  4. kallewoof approved
  5. fanquake approved
  6. fanquake commented at 3:52 AM on January 11, 2020: member

    ACK 498cdbb42616bc1e6c44492c907678b4dce41870

  7. fanquake renamed this:
    Fix improper Doxygen inline comments
    doc: Fix improper Doxygen inline comments
    on Jan 11, 2020
  8. fanquake referenced this in commit e258ce792a on Jan 11, 2020
  9. fanquake merged this on Jan 11, 2020
  10. fanquake closed this on Jan 11, 2020

  11. deadalnix referenced this in commit f5dd9ee879 on Nov 17, 2020
  12. DrahtBot locked this on Feb 15, 2022
Labels

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-22 18:14 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me