diff options
| author | Chris Sherlock <chris.sherlock79@gmail.com> | 2017-06-25 14:57:52 +1000 |
|---|---|---|
| committer | Chris Sherlock <chris.sherlock79@gmail.com> | 2017-06-25 15:01:24 +1000 |
| commit | b2f63a266396a38c7d88c397d26db1c08e5f7ef5 (patch) | |
| tree | 44aae8456149b73e1ac3c5eb3865af7c5c4a2c2e /include/osl | |
| parent | 61fc3ed179b324c58788d57f284fcc23d8258ae3 (diff) | |
osl: document and group code via doxygen
Change-Id: I9945df95e14fbca47f7cea80b1d4097d00a3eb54
Diffstat (limited to 'include/osl')
| -rw-r--r-- | include/osl/file.h | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/include/osl/file.h b/include/osl/file.h index 5708bc4cfc7d..af15d64d9b8d 100644 --- a/include/osl/file.h +++ b/include/osl/file.h @@ -314,19 +314,26 @@ SAL_DLLPUBLIC sal_Bool SAL_CALL osl_identicalDirectoryItem( oslDirectoryItem pItemA, oslDirectoryItem pItemB ); -/* File types */ +/** + @defgroup File types + */ typedef enum { - osl_File_Type_Directory, - osl_File_Type_Volume, - osl_File_Type_Regular, - osl_File_Type_Fifo, - osl_File_Type_Socket, - osl_File_Type_Link, - osl_File_Type_Special, - osl_File_Type_Unknown + osl_File_Type_Directory, /*< directory */ + osl_File_Type_Volume, /*< volume (e.g. C:, A:) */ + osl_File_Type_Regular, /*< regular file */ + osl_File_Type_Fifo, /*< named pipe */ + osl_File_Type_Socket, /*< socket */ + osl_File_Type_Link, /*< file link */ + osl_File_Type_Special, /*< special device file */ + osl_File_Type_Unknown /*< unknown file type */ } oslFileType; +/** @} */ + +/** + @defgroup File attributes -/* File attributes */ + @{ + */ #define osl_File_Attribute_ReadOnly 0x00000001 #define osl_File_Attribute_Hidden 0x00000002 #define osl_File_Attribute_Executable 0x00000010 @@ -339,9 +346,13 @@ typedef enum { #define osl_File_Attribute_OthWrite 0x00000800 #define osl_File_Attribute_OthRead 0x00001000 #define osl_File_Attribute_OthExe 0x00002000 +/** @} */ -/* Flags specifying which fields to retrieve by osl_getFileStatus */ +/** + @defgroup Flags specifying which fields to retrieve by osl_getFileStatus + @{ + */ #define osl_FileStatus_Mask_Type 0x00000001 #define osl_FileStatus_Mask_Attributes 0x00000002 #define osl_FileStatus_Mask_CreationTime 0x00000010 @@ -353,6 +364,7 @@ typedef enum { #define osl_FileStatus_Mask_LinkTargetURL 0x00000400 #define osl_FileStatus_Mask_All 0x7FFFFFFF #define osl_FileStatus_Mask_Validate 0x80000000 +/** @} */ /** Structure containing information about files and directories |