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: netsocket group doxygen fixes #8541

Merged
merged 13 commits into from Oct 27, 2018

Conversation

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

paul-szczepanek-arm commented Oct 24, 2018

Description

Doxygen cleanup, missing funcs doc added, removed protected. Use copydoc instead of copy-paste to avoid docs diverging.

Pull request type

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

paul-szczepanek-arm added some commits Oct 24, 2018

paul-szczepanek-arm added some commits Oct 24, 2018

incorrect doc was copy pasted
replaced with copydoc instead

@0xc0170 0xc0170 requested review from melwee01 and ARMmbed/mbed-os-ipcore Oct 25, 2018

* @param optval Option value
* @param optlen Length of the option value
* @return 0 on success, negative error code on failure
/** @copydoc NetworkStack::setsockopt

This comment has been minimized.

@kjbracey-arm

kjbracey-arm Oct 25, 2018

Contributor

Is even this explicit command necessary? The Doxygen config got automatic inheritance turned on recently, IIRC.

@melwee01

Inconsistency throughout on whether or not @return ends with a period or not.

/** CellularBase class
*
* Common interface that is shared between Cellular interfaces
/** Common interface that is shared between Cellular interfaces

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Missing .

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Is Cellular definitely a proper noun in this context?

This comment has been minimized.

@kjbracey-arm

kjbracey-arm Oct 25, 2018

Contributor

No, it isn't.

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Do not capitalize cellular.

@@ -22,9 +22,8 @@
#include "netsocket/NetworkInterface.h"
#include "netsocket/WiFiAccessPoint.h"

/** WiFiInterface class
/** Common interface that is shared between WiFi devices.

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Wi-Fi

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Though this depends entirely on context. Chasing up.

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Instances of Wi-Fi that are not a class or variable should be styled as Wi-Fi, not WiFi.

paul-szczepanek-arm added some commits Oct 25, 2018

@melwee01

This comment has been minimized.

Contributor

melwee01 commented Oct 25, 2018

Ah, sorry. Hadn't seen that you already changed the capitalization.

@0xc0170

This comment has been minimized.

Member

0xc0170 commented Oct 25, 2018

review two travis failues in docs

/home/travis/build/ARMmbed/mbed-os/features/netsocket/EthInterface.h:27: warning: Trying to add group netsocket to itself!
/home/travis/build/ARMmbed/mbed-os/features/netsocket/MeshInterface.h:27: warning: Trying to add group netsocket to itself!

@0xc0170 0xc0170 added needs: work and removed needs: review labels Oct 25, 2018

@@ -74,7 +74,7 @@ class WiFiInterface: public virtual NetworkInterface {
virtual nsapi_error_t connect(const char *ssid, const char *pass,
nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0) = 0;

/** Attempt to connect to a WiFi network. Requires ssid and passphrase to be set.
/** Attempt to connect to a Wi-Fi network. Requires ssid and passphrase to be set.

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

SSID

@@ -74,7 +74,7 @@ class WiFiInterface: public virtual NetworkInterface {
virtual nsapi_error_t connect(const char *ssid, const char *pass,
nsapi_security_t security = NSAPI_SECURITY_NONE, uint8_t channel = 0) = 0;

/** Attempt to connect to a WiFi network. Requires ssid and passphrase to be set.
/** Attempt to connect to a Wi-Fi network. Requires ssid and passphrase to be set.
* If passphrase is invalid, NSAPI_ERROR_AUTH_ERROR is returned.
*
* @return NSAPI_ERROR_OK on success, negative error code on failure

This comment has been minimized.

@melwee01

melwee01 Oct 25, 2018

Contributor

Missing .

@cmonr cmonr removed the rollup PR label Oct 25, 2018

paul-szczepanek-arm and others added some commits Oct 25, 2018

@cmonr cmonr added the rollup PR label Oct 26, 2018

melwee01 added some commits Oct 26, 2018

@cmonr cmonr removed the rollup PR label Oct 26, 2018

@cmonr cmonr added needs: CI rollup PR and removed needs: work labels Oct 26, 2018

@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.

If any more commits are made to this PR, this will have to go through CI on it's own.

@cmonr

cmonr approved these changes Oct 26, 2018

@cmonr cmonr referenced this pull request Oct 26, 2018

Merged

Rollup PR: UK Docathon pt2 #8552

@cmonr cmonr merged commit 2bab24f 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 9289 cycles (+106 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