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

docs: src/cellular/deploy.hpp:8: error: Compound Deployment is not documented. #59

Open
ntlhui opened this issue Oct 1, 2024 · 1 comment · May be fixed by #138
Open

docs: src/cellular/deploy.hpp:8: error: Compound Deployment is not documented. #59

ntlhui opened this issue Oct 1, 2024 · 1 comment · May be fixed by #138

Comments

@ntlhui
Copy link
Contributor

ntlhui commented Oct 1, 2024

at ed2263e
@ntlhui
Copy link
Contributor Author

ntlhui commented Oct 1, 2024

  • src/cellular/deploy.hpp:11: error: Member State_ (enumeration) of class Deployment is not documented.
  • src/cellular/deploy.hpp:13: error: Documentation for enum member 'Deployment::State_::READ' is missing.
  • src/cellular/deploy.hpp:14: error: Documentation for enum member 'Deployment::State_::WRITE' is missing.
  • src/cellular/deploy.hpp:15: error: Documentation for enum member 'Deployment::State_::RDWR' is missing.
  • src/cellular/deploy.hpp:16: error: Member State_e (typedef) of class Deployment is not documented.
  • src/cellular/deploy.hpp:18: error: Member getInstance(void) (function) of class Deployment is not documented.
  • src/cellular/deploy.hpp:85: error: Member Deployment(Deployment const &) (function) of class Deployment is not documented.
  • src/cellular/deploy.hpp:86: error: Member currentFile (variable) of class Deployment is not documented.
  • src/cellular/deploy.hpp:87: error: Member currentState (variable) of class Deployment is not documented.
  • src/cellular/deploy.hpp:88: error: Member filename[SF_NAME_MAX] (variable) of class Deployment is not documented.
  • :1: error: parameters of member Deployment::Deployment are not documented
  • :1: error: parameters of member Deployment::getInstance are not documented
  • src/cellular/deploy.hpp:75: error: argument 'size_t' of command @param is not found in the argument list of Deployment::truncate(size_t nBytes)
  • src/cellular/deploy.hpp:75: error: The following parameter of Deployment::truncate(size_t nBytes) is not documented: parameter 'nBytes'

ed2263e

@charliekush charliekush linked a pull request Nov 22, 2024 that will close this issue
chore: added docs to deploy.hpp #138
Open
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
No milestone
Development

Successfully merging a pull request may close this issue.

chore: added docs to deploy.hpp UCSD-E4E/smartfin-fw3
1 participant
@ntlhui