[trivial] Updates the ADD_SERIALIZE_METHODS documentation #14015

pull l2a5b1 wants to merge 1 commits into bitcoin:master from l2a5b1:patch/fix-add_serialize_methods-doc changing 1 files +1 −1
  1. l2a5b1 commented at 2:43 PM on August 21, 2018: contributor

    This pull request fixes a small error in the ADD_SERIALIZE_METHODS documentation.

    At the moment the ADD_SERIALIZE_METHODS macro adds two methods to a class:

    template<typename Stream>void Serialize(Stream& s) const { ... }
    template<typename Stream>void Unserialize(Stream& s) { ... }
    

    ADD_SERIALIZE_METHODS used to add three methods to a class:

    size_t GetSerializeSize(int nType, int nVersion) const {...}
    template<typename Stream>void Serialize(Stream& s, int nType, int nVersion) const  {...}
    template<typename Stream>void Unserialize(Stream& s, int nType, int nVersion)  {...}
    

    size_t GetSerializeSize(int nType, int nVersion) const was removed from the ADD_SERIALIZE_METHODS macro in 657e05ab2e87ff725723fe8a375fc3f8aad02126, but the documentation was not updated accordingly at the time.

    This pull request corrects this mistake.

  2. Updates the ADD_SERIALIZE_METHODS documentation.
    This commit fixes a small error in the `ADD_SERIALIZE_METHODS`
    documentation.
    9ff2f16376
  3. MarcoFalke added the label Docs on Aug 21, 2018
  4. DrahtBot commented at 5:55 PM on August 21, 2018: member

    <!--e57a25ab6845829454e8d69fc972939a-->Note to reviewers: This pull request conflicts with the following ones:

    • #10785 (Serialization improvements by sipa)

    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.

  5. l2a5b1 commented at 10:52 PM on August 21, 2018: contributor

    Unless there is somebody who thinks this PR is useful, I will close it shortly, because the ADD_SERIALIZE_METHODS documentation has been updated adequately in #10785.

  6. l2a5b1 closed this on Aug 23, 2018

  7. MarcoFalke locked this on Sep 8, 2021
Contributors
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:15 UTC

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