Skip to content

Minor Doxygen fixes for FileSystem #9308

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

Closed
wants to merge 2 commits into from
Closed

Minor Doxygen fixes for FileSystem #9308

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5bbdc0
Minor Doxygen fixes for FileSystem
Jan 9, 2019
eb79531
Update features/storage/filesystem/FileSystem.h
Jan 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions features/storage/filesystem/FileSystem.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,7 @@ class FileSystem : public FileSystemLike {
* Use the components in target.json or application config to change
* the default block device and affect the default filesystem.
* SD block device => FAT filesystem
* SPIF block device => LITTLE filesystem
* DATAFLASH block device => LITTLE filesystem
* QSPIF, SPIF, DATAFLASH or FLAHIAP block device => LITTLE filesystem
*
* An application can override all target settings by implementing
* FileSystem::get_default_instance() themselves - the default
Expand Down Expand Up @@ -133,6 +132,7 @@ class FileSystem : public FileSystemLike {
*/
virtual int statvfs(const char *path, struct statvfs *buf);

#if !(DOXYGEN_ONLY)
protected:
friend class File;
friend class Dir;
Expand Down Expand Up @@ -180,21 +180,21 @@ class FileSystem : public FileSystemLike {
virtual int file_sync(fs_file_t file);

/** Check if the file in an interactive terminal device
* If so, line buffered behaviour is used by default
* If so, line buffered behavior is used by default
*
* @param file File handle
* @return True if the file is a terminal
*/
virtual int file_isatty(fs_file_t file);

/** Move the file position to a given offset from from a given location
/** Move the file position to a given offset from a given location
*
* @param file File handle
* @param offset The offset from whence to move to
* @param whence The start of where to seek
* SEEK_SET to start from beginning of file,
* SEEK_CUR to start from current position in file,
* SEEK_END to start from end of file
* SEEK_SET to start from the beginning of file,
* SEEK_CUR to start from the current position in the file,
* SEEK_END to start from the end of file
* @return The new offset of the file
*/
virtual off_t file_seek(fs_file_t file, off_t offset, int whence) = 0;
Expand Down Expand Up @@ -224,7 +224,7 @@ class FileSystem : public FileSystemLike {
*
* The file's length is set to the specified value. The seek pointer is
* not changed. If the file is extended, the extended area appears as if
* it were zero-filled.
* it was zero-filled.
*
* @param file File handle
* @param length The requested new length for the file
Expand Down Expand Up @@ -288,6 +288,8 @@ class FileSystem : public FileSystemLike {
// Hooks for FileSystemHandle
virtual int open(FileHandle **file, const char *path, int flags);
virtual int open(DirHandle **dir, const char *path);

#endif //!defined(DOXYGEN_ONLY)
};


Expand Down