gfileinfo: Clarify units in documentation for file attributes

Clarify that the G_FILE_ATTRIBUTE_TIME_* attributes are all in seconds
(apart from the *_USEC ones, which are documented separately).
This commit is contained in:
Philip Withnall 2017-01-24 12:52:24 +00:00
parent 740007c11e
commit 95afbe1666

View File

@ -473,8 +473,8 @@ typedef struct _GFileInfoClass GFileInfoClass;
* *
* A key in the "time" namespace for getting the time the file was last * A key in the "time" namespace for getting the time the file was last
* modified. Corresponding #GFileAttributeType is * modified. Corresponding #GFileAttributeType is
* %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the
* file was modified. * file was modified, in seconds since the UNIX epoch.
**/ **/
#define G_FILE_ATTRIBUTE_TIME_MODIFIED "time::modified" /* uint64 */ #define G_FILE_ATTRIBUTE_TIME_MODIFIED "time::modified" /* uint64 */
@ -493,8 +493,8 @@ typedef struct _GFileInfoClass GFileInfoClass;
* *
* A key in the "time" namespace for getting the time the file was last * A key in the "time" namespace for getting the time the file was last
* accessed. Corresponding #GFileAttributeType is * accessed. Corresponding #GFileAttributeType is
* %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the UNIX time since the * %G_FILE_ATTRIBUTE_TYPE_UINT64, and contains the time since the
* file was last accessed. * file was last accessed, in seconds since the UNIX epoch.
**/ **/
#define G_FILE_ATTRIBUTE_TIME_ACCESS "time::access" /* uint64 */ #define G_FILE_ATTRIBUTE_TIME_ACCESS "time::access" /* uint64 */
@ -513,7 +513,8 @@ typedef struct _GFileInfoClass GFileInfoClass;
* *
* A key in the "time" namespace for getting the time the file was last * A key in the "time" namespace for getting the time the file was last
* changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, * changed. Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
* and contains the UNIX time since the file was last changed. * and contains the time since the file was last changed, in seconds since the
* UNIX epoch.
* *
* This corresponds to the traditional UNIX ctime. * This corresponds to the traditional UNIX ctime.
**/ **/
@ -534,7 +535,8 @@ typedef struct _GFileInfoClass GFileInfoClass;
* *
* A key in the "time" namespace for getting the time the file was created. * A key in the "time" namespace for getting the time the file was created.
* Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64, * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT64,
* and contains the UNIX time since the file was created. * and contains the time since the file was created, in seconds since the UNIX
* epoch.
* *
* This corresponds to the NTFS ctime. * This corresponds to the NTFS ctime.
**/ **/