diff options
| author | inmarket <andrewh@inmarket.com.au> | 2014-09-29 16:09:08 +1000 |
|---|---|---|
| committer | inmarket <andrewh@inmarket.com.au> | 2014-09-29 16:09:08 +1000 |
| commit | b7a89b2adaa9ee170d20a0454309ed204a6ffa39 (patch) | |
| tree | af5539a4313ab55a94ef7989e846a25033c900af /src/gfile | |
| parent | 4cf198aad2120bfb2906e4f280562fe185524717 (diff) | |
| download | uGFX-b7a89b2adaa9ee170d20a0454309ed204a6ffa39.tar.gz uGFX-b7a89b2adaa9ee170d20a0454309ed204a6ffa39.tar.bz2 uGFX-b7a89b2adaa9ee170d20a0454309ed204a6ffa39.zip | |
doxygen updates
Diffstat (limited to 'src/gfile')
| -rw-r--r-- | src/gfile/sys_defs.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/gfile/sys_defs.h b/src/gfile/sys_defs.h index 5a2d9845..2c475b40 100644 --- a/src/gfile/sys_defs.h +++ b/src/gfile/sys_defs.h @@ -103,21 +103,21 @@ extern "C" { * @return Valid GFILE on success, 0 otherwise * * @note The modes follow the c library fopen() standard. - * The valid modes are:<br/> + * The valid modes are: * <ul><li>r - Open for read, the file must exist</li> * <li>w - Open for write, the file is truncated if it exists</li> * <li>wx - Open for write, the file must not exist</li> * <li>a - Open for append, the file is truncated if it exists</li> * <li>ax - Open for append, the file must not exists</li> - * </ul><br/> - * THe following flags can also be added to the above modes:<br/> + * </ul> + * The following flags can also be added to the above modes:<br/> * <ul><li>+ - Open for both read and write</li> * <li>b - Open as a binary file rather than a text file</li> - * <ul> + * </ul> * @note Not all file-systems support all modes. For example, write * is not available with the ROM file-system. Similarly few platforms * distinguish between binary and text files. - * @note Even though binary vs text is relevant only for a small number of platforms + * @note Even though binary vs. text is relevant only for a small number of platforms * the "b" flag should always be specified for binary files such as images. * This ensures portability to other platforms. The extra flag will be ignored * on platforms where it is not relevant. @@ -346,8 +346,8 @@ extern "C" { /** * @brief Open file from a null terminated C string * - * @param[in] memptr The pointer to the string or string buffer - * @param[in] mode The mode. + * @param[in] str The pointer to the string or string buffer + * @param[in] mode The mode * * @return Valid GFILE on success, 0 otherwise * |