ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Copy edit GattServer.h 

Copy edit, mostly for consistent tense and hyphenation.
pull/5392/head
Amanda Butler 2017-11-07 17:56:44 -06:00 committed by GitHub
parent 5178f89c8b
commit 6e20887724
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
features/FEATURE_BLE/ble/GattServer.h
View File

@ -99,7 +99,7 @@ protected:
} }
/* /*
* The following functions are meant to be overridden in the platform-specific sub-class. * The following functions are meant to be overridden in the platform-specific subclass.
*/ */
public: public:
@ -129,7 +129,7 @@ public:
* @param[in,out] lengthP * @param[in,out] lengthP
* Length of the buffer being supplied. If the attribute * Length of the buffer being supplied. If the attribute
* value is longer than the size of the supplied buffer, * value is longer than the size of the supplied buffer,
* this variable will hold upon return the total attribute value length * this variable holds upon return the total attribute value length
* (excluding offset). The application may use this * (excluding offset). The application may use this
* information to allocate a suitable buffer size. * information to allocate a suitable buffer size.
* *
@ -156,7 +156,7 @@ public:
* @param[in,out] lengthP * @param[in,out] lengthP
* Length of the buffer being supplied. If the attribute * Length of the buffer being supplied. If the attribute
* value is longer than the size of the supplied buffer, * value is longer than the size of the supplied buffer,
* this variable will hold upon return the total attribute value length * this variable holds upon return the total attribute value length
* (excluding offset). The application may use this * (excluding offset). The application may use this
* information to allocate a suitable buffer size. * information to allocate a suitable buffer size.
* *
@ -287,12 +287,12 @@ public:
} }
/* /*
* APIs with non-virtual implementations. * APIs with nonvirtual implementations.
*/ */
public: public:
/** /**
* Add a callback for the GATT event DATA_SENT (which is triggered when * Add a callback for the GATT event DATA_SENT (which is triggered when
* updates are sent out by GATT in the form of notifications). * GATT sends updates in the form of notifications).
* *
* @param[in] callback * @param[in] callback
* Event handler being registered. * Event handler being registered.
@ -309,7 +309,7 @@ public:
} }
/** /**
* Same as GattServer::onDataSent(), but allows the possibility to add an object * Same as GattServer::onDataSent() but it allows the possibility to add an object
* reference and member function as handler for DATA_SENT event * reference and member function as handler for DATA_SENT event
* callbacks. * callbacks.
* *
@ -359,8 +359,8 @@ public:
} }
/** /**
* Same as GattServer::onDataWritten(), but allows the possibility to add an object * Same as GattServer::onDataWritten() but it allows the possibility to add an object
* reference and member function as handler for data written event * reference and member function as a handler for data written event
* callbacks. * callbacks.
* *
* @param[in] objPtr * @param[in] objPtr
@ -389,8 +389,8 @@ public:
} }
/** /**
* Setup a callback to be invoked on the peripheral when an attribute is * Set up a callback to be invoked on the peripheral when a remote client is
* being read by a remote client. * reading an attribute.
* *
* @param[in] callback * @param[in] callback
* Event handler being registered. * Event handler being registered.
@ -422,7 +422,7 @@ public:
} }
/** /**
* Same as GattServer::onDataRead(), but allows the possibility to add an object * Same as GattServer::onDataRead() but it allows the possibility to add an object
* reference and member function as handler for data read event * reference and member function as handler for data read event
* callbacks. * callbacks.
* *
@ -478,7 +478,7 @@ public:
} }
/** /**
* Same as GattServer::onShutdown(), but allows the possibility to add an object * Same as GattServer::onShutdown() but it allows the possibility to add an object
* reference and member function as handler for shutdown event * reference and member function as handler for shutdown event
* callbacks. * callbacks.
* *
@ -620,9 +620,9 @@ public:
* associated object. * associated object.
* *
* This function is meant to be overridden in the platform-specific * This function is meant to be overridden in the platform-specific
* sub-class. Nevertheless, the sub-class is only expected to reset its * subclass. Nevertheless, the subclass only resets its
* state and not the data held in GattServer members. This shall be achieved * state and not the data held in GattServer members. This is achieved
* by a call to GattServer::reset() from the sub-class' reset() * by a call to GattServer::reset() from the subclass' reset()
* implementation. * implementation.
* *
* @return BLE_ERROR_NONE on success. * @return BLE_ERROR_NONE on success.