Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix doxygen docs in node_impl.hxx #2375

Closed
1 of 17 tasks
abitmore opened this issue Mar 9, 2021 · 1 comment · Fixed by #2403
Closed
1 of 17 tasks

Fix doxygen docs in node_impl.hxx #2375

abitmore opened this issue Mar 9, 2021 · 1 comment · Fixed by #2403
Milestone
5.2.0 - Feature R...

Comments

@abitmore
Copy link
Member

abitmore commented Mar 9, 2021 •
edited
Loading

Description

The doxygen format used in node_impl.hxx is largely incorrect. For an example, check this URL: https://doxygen.bitshares.org/classgraphene_1_1net_1_1detail_1_1node__impl.html#ac09b1d2d1c41d8bb1ca3be00472d64aa, the description is clearly not for the member variable.

image

Impacts
Describe which portion(s) of BitShares Core may be impacted by this bug. Please tick at least one box.

  • API (the application programming interface)
  • Build (the build process or something prior to compiled code)
  • CLI (the command line wallet)
  • Deployment (the deployment process after building such as Docker, Travis, etc.)
  • DEX (the Decentralized EXchange, market engine, etc.)
  • P2P (the peer-to-peer network for transaction/block propagation)
  • Performance (system or user efficiency, etc.)
  • Protocol (the blockchain logic, consensus, validation, etc.)
  • Security (the security of system or user data, etc.)
  • UX (the User Experience)
  • Other: docs

CORE TEAM TASK LIST

  • Evaluate / Prioritize Bug Report
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution
  • Perform QA/Testing
  • Update Documentation
@abitmore abitmore added this to the 5.2.0 - Feature Release milestone Mar 9, 2021
@abitmore abitmore mentioned this issue Apr 13, 2021
Merged
@abitmore abitmore linked a pull request Apr 13, 2021 that will close this issue
Fix doxygen docs in node_impl.hxx #2403
Merged
@abitmore
Copy link
Member Author

Fixed by #2403.

@abitmore abitmore mentioned this issue Apr 18, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
5.2.0 - Feature Release
Development

Successfully merging a pull request may close this issue.

Fix doxygen docs in node_impl.hxx bitshares/bitshares-core
1 participant
@abitmore