doc: add a brief description to each namespace #24073

issue niVelion opened this issue on January 14, 2022
  1. niVelion commented at 2:41 PM on January 14, 2022: none

    Is your feature request related to a problem? Please describe.

    Many namespaces are as yet un-annotated with a brief description, as used by Doxygen to generate developer documentation, locally or at https://doxygen.bitcoincore.org/namespaces.html.

    <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

    Incomplete developer documentation may affect developer onboarding time, and this seems like low-hanging fruit.

    Describe the solution you'd like

    <!-- A clear and concise description of what you want to happen. -->

    To add annotations to each of these namespaces. There may be existing descriptions elsewhere, if not I or someone else could attempt to describe each namespace, and reviewers could suggest improvements or alternatives.

    Describe alternatives you've considered

    <!-- A clear and concise description of any alternative solutions or features you've considered. -->

    Ideally each description would be committed by its author, so perhaps handling this with one PR that is then squashed isn't the best solution.

    On the other hand, if this would ease developer onboarding perhaps that's more important.

    Additional context

    Documentation at time of opening 14/12/2022:

    doxygen-namespaces-20211214

  2. niVelion added the label Feature on Jan 14, 2022
  3. MarcoFalke commented at 2:46 PM on January 14, 2022: member

    I think the namespace names are pretty self-explanatory. For example bech32 holds utility functions and code related to bech32. If you want to learn more details about something in a namespace, I recommend reading the class or function documentation.

  4. fanquake closed this on Jan 15, 2022

  5. DrahtBot locked this on Jan 15, 2023
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-05-02 12:14 UTC

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