Skip to content

Docs: netsocket group doxygen fixes #8541

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
Merged
merged 13 commits into from
Oct 27, 2018
Merged

Docs: netsocket group doxygen fixes #8541

merged 13 commits into from
Oct 27, 2018

Conversation

paul-szczepanek-arm
Copy link
Member

@paul-szczepanek-arm paul-szczepanek-arm commented Oct 24, 2018 •
edited
Loading

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

@0xc0170 0xc0170 requested review from melwee01 and a team October 25, 2018 08:42
kjbracey
kjbracey reviewed Oct 25, 2018
View reviewed changes
components/wifi/esp8266-driver/ESP8266Interface.h
* @param optval Option value
* @param optlen Length of the option value
* @return 0 on success, negative error code on failure
/** @copydoc NetworkStack::setsockopt
Copy link
Contributor

Choose a reason for hiding this comment

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

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

melwee01
melwee01 reviewed Oct 25, 2018
View reviewed changes
Copy link
Contributor

@melwee01 melwee01 left a comment

Choose a reason for hiding this comment

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

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

features/netsocket/CellularBase.h Outdated
/** CellularBase class
*
* Common interface that is shared between Cellular interfaces
/** Common interface that is shared between Cellular interfaces
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing .

Copy link
Contributor

Choose a reason for hiding this comment

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

Is Cellular definitely a proper noun in this context?

Copy link
Contributor

Choose a reason for hiding this comment

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

No, it isn't.

Copy link
Contributor

Choose a reason for hiding this comment

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

Do not capitalize cellular.

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

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

Choose a reason for hiding this comment

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

Wi-Fi

Copy link
Contributor

Choose a reason for hiding this comment

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

Though this depends entirely on context. Chasing up.

Copy link
Contributor

Choose a reason for hiding this comment

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

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

@melwee01
Copy link
Contributor

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

@0xc0170
Copy link
Contributor

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!

melwee01
melwee01 reviewed Oct 25, 2018
View reviewed changes
features/netsocket/WiFiInterface.h
@@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

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

SSID

melwee01
melwee01 reviewed Oct 25, 2018
View reviewed changes
features/netsocket/WiFiInterface.h Outdated
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing .

@cmonr cmonr removed the rollup PR label Oct 25, 2018
@cmonr cmonr removed the rollup PR label Oct 26, 2018
@cmonr
Copy link
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 mentioned this pull request Oct 26, 2018
Merged
@cmonr cmonr merged commit 2bab24f into ARMmbed:master Oct 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kjbracey kjbracey kjbracey left review comments

@melwee01 melwee01 melwee01 left review comments

@cmonr cmonr cmonr approved these changes

@AnotherButler AnotherButler Awaiting requested review from AnotherButler

Assignees
No one assigned
Labels
release-version: 5.10.3
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@paul-szczepanek-arm @melwee01 @0xc0170 @cmonr @kjbracey @adbridge