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

Adds description for all methods within server and client c files wit… #2

Merged

Conversation

NihadF7
Copy link

@NihadF7 NihadF7 commented May 10, 2024

Added descriptions to methods for lwm2mserver and lwm2mclient c files

@NihadF7 NihadF7 added the documentation Improvements or additions to documentation label May 10, 2024
@NihadF7 NihadF7 self-assigned this May 10, 2024
Copy link

@ssalkic ssalkic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general, we are on the right path. Good job. We just need to expand our descriptions and comments to be a bit more thorough.

examples/client/lwm2mclient.c Show resolved Hide resolved
examples/client/lwm2mclient.c Show resolved Hide resolved
examples/client/lwm2mclient.c Show resolved Hide resolved
examples/client/lwm2mclient.c Show resolved Hide resolved
examples/client/lwm2mclient.c Show resolved Hide resolved
examples/server/lwm2mserver.c Show resolved Hide resolved
examples/server/lwm2mserver.c Show resolved Hide resolved
examples/server/lwm2mserver.c Show resolved Hide resolved
examples/server/lwm2mserver.c Show resolved Hide resolved
examples/server/lwm2mserver.c Show resolved Hide resolved
@marcoraddatz marcoraddatz removed their request for review May 15, 2024 09:04
examples/client/lwm2mclient.c Show resolved Hide resolved
@ssalkic
Copy link

ssalkic commented Jun 4, 2024

@NihadF7 @marcoraddatz This is approved, we can merge it. I would also advise that we include a new ticket during code implementation which will include additional creation of the documentation for data types,function and use cases in a .md format, as mentioned in resolved comments. This can be done during code implementation as a acceptance criteria.

@NihadF7 NihadF7 merged commit 6598f8e into master Jun 4, 2024
2 of 58 checks passed
@NihadF7 NihadF7 deleted the 36-wakaama-document-methods-from-examples-in-wakaama branch June 4, 2024 10:25
@NihadF7
Copy link
Author

NihadF7 commented Jun 4, 2024

I agree with @ssalkic proposal. PR merged. Closing as done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants