Library to allo USB PTP device to be hosted by the mbed platform
Dependents: class_project_main
Diff: PIMA15740/PIMAString.h
- Revision:
- 3:1fcb46ab18df
- Parent:
- 2:67753d738eb8
diff -r 67753d738eb8 -r 1fcb46ab18df PIMA15740/PIMAString.h --- a/PIMA15740/PIMAString.h Fri Aug 23 20:02:44 2013 +0000 +++ b/PIMA15740/PIMAString.h Fri Aug 23 23:34:05 2013 +0000 @@ -4,15 +4,17 @@ * @author Dwayne Dilbeck * @date 8/23/2013 * -* mbed USBHostPTP Library(PIMA15740 definitions) -* Copyright (c) 2013 Dwayne Dilbeck -* This software is distributed under the terms of the GNU Lesser General Public License +* mbed USBHostPTP Library(PIMA15740 String definition) +* @par Copyright: +* Copyright (c) 2013 Dwayne Dilbeck +* @par License: +* This software is distributed under the terms of the GNU Lesser General Public License */ /** * Class PIMA String * -* The PIMA15740 standard defines a string as an 8bit length followed by a list +* The PIMA15740 standard defines a string as an unsigned 8bit length followed by a list * of 16bit unicode characters * */ @@ -21,6 +23,7 @@ /** * Constructor + * * By default the pointers are set to NULL and length set to ZERO. */ PIMAString() { @@ -31,7 +34,8 @@ /** * Desctructor - * Free the Memory allocated for cahracter storage + * + * Free the Memory allocated for character storage */ ~PIMAString() { if( StringChars !=NULL) @@ -41,10 +45,11 @@ }; /** + * Create and fill character storage from a supplied buffer pointer * * @param currentPtr a unit8_t pointer to a buffer location where a PIMAString shoudl be read * - * @return The number of bytes used to from the buffer to create the PIMA string. + * @return The number of bytes used from the buffer to create the PIMA string. */ int FillString(uint8_t *currentPtr) { setLength(*currentPtr);