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.

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

Doxygen warnings #2213

Open
1 of 17 tasks
abitmore opened this issue Jun 30, 2020 · 2 comments
Open
1 of 17 tasks

Doxygen warnings #2213

abitmore opened this issue Jun 30, 2020 · 2 comments

Comments

@abitmore
Copy link
Member

abitmore commented Jun 30, 2020

User Story

There are quite some warnings when generating documentation via the doxygen tool.

Details: #2213 (comment).

Impacts
Describe which portion(s) of BitShares Core may be impacted by your request. 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: documentation

CORE TEAM TASK LIST

  • Evaluate / Prioritize Feature Request
  • Refine User Stories / Requirements
  • Define Test Cases
  • Design / Develop Solution
  • Perform QA/Testing
  • Update Documentation
@abitmore
Copy link
Member Author

abitmore commented Jan 6, 2021

Item(s) unable to fix so far:

  • warning: documented symbol `graphene::chain::decltype' was not declared or defined on several files
  • warning: no uniquely matching class member found for (some methods in some template classes), E.G.
libraries/fc/include/fc/fwd_impl.hpp:128: warning: no uniquely matching class member found for
  template < T, S, A >
  T & fc::fwd< T, S, A >::operator=(fc::fwd< T, S, A > &&u)
Possible candidates:
  'template < U >
  T & fc::fwd< T, S, Align >::operator=(U &&u)' at line 31 of file /home/ubuntu/bitshares-core-dev/libraries/fc/include/fc/fwd.hpp
  T & fc::fwd< T, S, Align >::operator=(fwd &&u)' at line 33 of file /home/ubuntu/bitshares-core-dev/libraries/fc/include/fc/fwd.hpp
  T & fc::fwd< T, S, Align >::operator=(const fwd &u)' at line 34 of file /home/ubuntu/bitshares-core-dev/libraries/fc/include/fc/fwd.hpp
  • libraries/fc/include/fc/thread/parallel.hpp:91: warning: argument 'desc' of command @param is not found in the argument list of fc::do_parallel(Functor &&f, const char *desc FC_TASK_NAME_DEFAULT_ARG) ->-> fc::future< decltype(f())> (and some other files), and parameter 'FC_TASK_NAME_DEFAULT_ARG' is "not documented"
    • Doxygen thinks FC_TASK_NAME_DEFAULT_ARG is the argument
  • README.md:6: warning: Unexpected html tag <img> found within <a href=...> context
    • The section will be removed from the generated HTML file anyway

@abitmore
Copy link
Member Author

abitmore commented Jan 8, 2021

Mostly fixed by #2324. Moving the issue to the next milestone.

@abitmore abitmore changed the title Fix Doxygen warnings Doxygen warnings Oct 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant