Minor Doxygen fixes for BufferedBlockDevice and iBeacon #9333
Conversation
|
@AnotherButler , @GuyWi - Please review |
|
@offirko, thank you for your changes. |
| @@ -35,35 +35,36 @@ namespace mbed { | |||
| */ | |||
| class BufferedBlockDevice : public BlockDevice { | |||
| public: | |||
| /** Lifetime of the memory block device | |||
| /** Create a memory-buffered block device wrapping an underlying block device | |||
There was a problem hiding this comment.
"Lifetime" is actually a standard phrase for the constructor.
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| * Copyright (c) 2006-2015 ARM Limited |
There was a problem hiding this comment.
hmm not sure why, guess its a result of : astyle --options=.astylerc
| @@ -176,12 +176,11 @@ class iBeacon | |||
| len(0x15), | |||
| majorNumber(__REV16(majNum)), | |||
| minorNumber(__REV16(minNum)), | |||
| txPower(transmitPower) | |||
| { | |||
| txPower(transmitPower) { | |||
There was a problem hiding this comment.
According to mbed os guideline, { should be position on a new line when a function scope is opened.
There was a problem hiding this comment.
again a result of: astyle --options=.astylerc
There was a problem hiding this comment.
BLE files are being ignored so shall not be changed - should be done as one update but requires more effort
| @@ -192,14 +191,14 @@ class iBeacon | |||
| * to group their iBeacons into a single network, a single region and | |||
| * identify their organization among others. | |||
| * | |||
| * @param[in] majNum Beacon major group ID. iBeacon exploitants may use | |||
| * this field to divide the region into subregions, their network into | |||
| * @param[in] majNum Beacon major group ID. iBeacon users may use | |||
There was a problem hiding this comment.
iBeacon users may referred to end users that or the business operating an iBeacon fleet. I'd suggest iBeacon fleet operator
Technical author review
|
@offirko - I committed some language edits. |
|
@pan @davidsaada Changes look good now? |
|
CI started |
Test run: SUCCESSSummary: 11 of 11 test jobs passed |
Description
Minor Doxygen fixes for BufferedBlockDevice and iBeacon
Pull request type
Reviewers