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

Docs: InternetSocket doxygen fixes #8534

Merged
merged 2 commits into from Oct 27, 2018

Conversation

Projects
None yet
3 participants
@paul-szczepanek-arm
Member

paul-szczepanek-arm commented Oct 24, 2018

Description

Hide helper func, cleanup doxygen. Since it inherits from socket I also fixed some (accidentally?) missing doxygen comments there.

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x] Docs update
[ ] Test update
[ ] Breaking change

@paul-szczepanek-arm paul-szczepanek-arm changed the title from update internetsocket docs to Docs: InternetSocket doxygen fixes Oct 24, 2018

@paul-szczepanek-arm

This comment has been minimized.

Member

paul-szczepanek-arm commented Oct 24, 2018

almost no factual errors, I just mostly fixed style as I went through it

*/
nsapi_error_t open(NetworkStack *stack);

#if !defined(DOXYGEN_ONLY)

This comment has been minimized.

@paul-szczepanek-arm

paul-szczepanek-arm Oct 24, 2018

Member

this is just a convenience func for casting

@cmonr

cmonr approved these changes Oct 25, 2018

Edit InternetSocket.h
Edit file, mostly for branding, commas and U.S. spelling.
@cmonr

This comment has been minimized.

Contributor

cmonr commented Oct 26, 2018

Note: This PR is now a part of a rollup PR (#8552).

No further work is needed here, as once that PR is merged, this PR will also be closed and marked as merged.

@cmonr cmonr merged commit 6db0f67 into ARMmbed:master Oct 27, 2018

11 checks passed

continuous-integration/jenkins/pr-head This commit looks good
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
jenkins-ci/cloud-client-test Success
Details
jenkins-ci/unittests Success
Details
travis-ci/astyle Passed, 536 files (+0 files)
Details
travis-ci/docs Local docs testing has passed
Details
travis-ci/events Passed, runtime is 10044 cycles (+38 cycles)
Details
travis-ci/gitattributestest Local gitattributestest testing has passed
Details
travis-ci/licence_check Local licence_check testing has passed
Details
travis-ci/littlefs Passed, code size is 8372B (+0.00%)
Details
travis-ci/tools-py2.7 Local tools-py2.7 testing has passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment