[glibmm] Remove redundant documentation of enum Glib::FileError::Code



commit c0ac0dc37e3e653d4dd5d3484f0b734a7e55d525
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Mon Jun 12 15:44:15 2017 +0200

    Remove redundant documentation of enum Glib::FileError::Code
    
    * glib/src/fileutils.hg: Remove documentation of FileError::Code that
    duplicates documentation generated by _WRAP_GERROR.

 glib/src/fileutils.hg |  211 +++++++++++++++++--------------------------------
 1 files changed, 72 insertions(+), 139 deletions(-)
---
diff --git a/glib/src/fileutils.hg b/glib/src/fileutils.hg
index b8792b6..e660ca5 100644
--- a/glib/src/fileutils.hg
+++ b/glib/src/fileutils.hg
@@ -63,146 +63,79 @@ _WRAP_GERROR(FileError, GFileError, G_FILE_ERROR, NO_GTYPE,
     s#^PERM$#NOT_OWNER#
 )
 
-/** @enum FileError::Code
- * Values corresponding to <tt>errno</tt> codes returned from file operations
- * on UNIX.
- * Unlike <tt>errno</tt> codes, FileError::Code values are available on all
- * systems, even Windows. The exact meaning of each code depends on what sort
- * of file operation you were performing; the UNIX documentation gives more
- * details.  The following error code descriptions come from the GNU C Library
- * manual, and are under the copyright of that manual.
- *
- * It's not very portable to make detailed assumptions about exactly which
- * errors will be returned from a given operation. Some errors don't occur on
- * some systems, etc., sometimes there are subtle differences in when a system
- * will report a given error, etc.
- */
-
 /** @var FileError::Code FileError::EXISTS
- * <tt>(EEXIST)</tt> Operation not permitted; only the owner of the file (or
- * other resource) or processes with special privileges can perform the operation.
- * <br><br>
- */
-/** @var FileError::Code FileError::IS_DIRECTORY
- * <tt>(EISDIR)</tt> File is a directory; you cannot open a directory for writing,
- * or create or remove hard links to it.
- * <br><br>
- */
-/** @var FileError::Code FileError::ACCESS_DENIED
- * <tt>(EACCES)</tt> Permission denied; the file permissions do not allow the
- * attempted operation.
- * <br><br>
- */
-/** @var FileError::Code FileError::NAME_TOO_LONG
- * <tt>(ENAMETOOLONG)</tt> Filename too long.
- * <br><br>
- */
-/** @var FileError::Code FileError::NO_SUCH_ENTITY
- * <tt>(ENOENT)</tt> No such file or directory.  This is a "file doesn't exist"
- * error for ordinary files that are referenced in contexts where they are expected
- * to already exist.
- * <br><br>
- */
-/** @var FileError::Code FileError::NOT_DIRECTORY
- * <tt>(ENOTDIR)</tt> A file that isn't a directory was specified when a directory
- * is required.
- * <br><br>
- */
-/** @var FileError::Code FileError::NO_SUCH_DEVICE
- * <tt>(ENXIO)</tt> No such device or address.  The system tried to use the device
- * represented by a file you specified, and it couldn't find the device. This can
- * mean that the device file was installed incorrectly, or that the physical device
- * is missing or not correctly attached to the computer.
- * <br><br>
- */
-/** @var FileError::Code FileError::NOT_DEVICE
- * <tt>(ENODEV)</tt> This file is of a type that doesn't support mapping.
- * <br><br>
- */
-/** @var FileError::Code FileError::READONLY_FILESYSTEM
- * <tt>(EROFS)</tt> The directory containing the new link can't be modified
- * because it's on a read-only file system.
- * <br><br>
- */
-/** @var FileError::Code FileError::TEXT_FILE_BUSY
- * <tt>(ETXTBSY)</tt> Text file busy.
- * <br><br>
- */
-/** @var FileError::Code FileError::FAULTY_ADDRESS
- * <tt>(EFAULT)</tt> You passed in a pointer to bad memory.  (Glib won't
- * reliably return this, don't pass in pointers to bad memory.)
- * <br><br>
- */
-/** @var FileError::Code FileError::SYMLINK_LOOP
- * <tt>(ELOOP)</tt> Too many levels of symbolic links were encountered in
- * looking up a file name.  This often indicates a cycle of symbolic links.
- * <br><br>
- */
-/** @var FileError::Code FileError::NO_SPACE_LEFT
- * <tt>(ENOSPC)</tt> No space left on device; write operation on a file failed
- * because the disk is full.
- * <br><br>
- */
-/** @var FileError::Code FileError::NOT_ENOUGH_MEMORY
- * <tt>(ENOMEM)</tt> No memory available.  The system cannot allocate more
- * virtual memory because its capacity is full.
- * <br><br>
- */
-/** @var FileError::Code FileError::TOO_MANY_OPEN_FILES
- * <tt>(EMFILE)</tt> The current process has too many files open and can't
- * open any more.  Duplicate descriptors do count toward this limit.
- * <br><br>
- */
-/** @var FileError::Code FileError::FILE_TABLE_OVERFLOW
- * <tt>(ENFILE)</tt> There are too many distinct file openings in the
- * entire system.
- * <br><br>
- */
-/** @var FileError::Code FileError::BAD_FILE_DESCRIPTOR
- * <tt>(EBADF)</tt> Bad file descriptor; for example, I/O on a descriptor
- * that has been closed or reading from a descriptor open only for writing
- * (or vice versa).
- * <br><br>
- */
-/** @var FileError::Code FileError::INVALID_ARGUMENT
- * <tt>(EINVAL)</tt> Invalid argument. This is used to indicate various kinds
- * of problems with passing the wrong argument to a library function.
- * <br><br>
- */
-/** @var FileError::Code FileError::BROKEN_PIPE
- * <tt>(EPIPE)</tt> Broken pipe; there is no process reading from the other
- * end of a pipe.  Every library function that returns this error code also
- * generates a <tt>SIGPIPE</tt> signal; this signal terminates the program
- * if not handled or blocked.  Thus, your program will never actually see
- * this code unless it has handled or blocked <tt>SIGPIPE</tt>.
- * <br><br>
- */
-/** @var FileError::Code FileError::TRYAGAIN
- * <tt>(EAGAIN)</tt> Resource temporarily unavailable; the call might work
- * if you try again later.
- * We used TRYAGAIN instead of TRY_AGAIN, because that is a defined as a macro by a Unix header.
- * <br><br>
- */
-/** @var FileError::Code FileError::INTERRUPTED
- * <tt>(EINTR)</tt> Interrupted function call; an asynchronous signal occurred
- * and prevented completion of the call.  When this happens, you should try
- * the call again.
- * <br><br>
- */
-/** @var FileError::Code FileError::IO_ERROR
- * <tt>(EIO)</tt> Input/output error; usually used for physical read or write
- * errors.  I.e. the disk or other physical device hardware is returning errors.
- * <br><br>
- */
-/** @var FileError::Code FileError::NOT_OWNER
- * <tt>(EPERM)</tt> Operation not permitted; only the owner of the file (or other
- * resource) or processes with special privileges can perform the operation.
- * <br><br>
- */
-/** @var FileError::Code FileError::FAILED
- * Does not correspond to a UNIX error code; this is the standard "failed for
- * unspecified reason" error code present in all Glib::Error error code
- * enumerations.  Returned if no specific code applies.
+ * <tt>(EEXIST)</tt>
+ *
+ * @var FileError::Code FileError::IS_DIRECTORY
+ * <tt>(EISDIR)</tt>
+ *
+ * @var FileError::Code FileError::ACCESS_DENIED
+ * <tt>(EACCES)</tt>
+ *
+ * @var FileError::Code FileError::NAME_TOO_LONG
+ * <tt>(ENAMETOOLONG)</tt>
+ *
+ * @var FileError::Code FileError::NO_SUCH_ENTITY
+ * <tt>(ENOENT)</tt>
+ *
+ * @var FileError::Code FileError::NOT_DIRECTORY
+ * <tt>(ENOTDIR)</tt>
+ *
+ * @var FileError::Code FileError::NO_SUCH_DEVICE
+ * <tt>(ENXIO)</tt>
+ *
+ * @var FileError::Code FileError::NOT_DEVICE
+ * <tt>(ENODEV)</tt>
+ *
+ * @var FileError::Code FileError::READONLY_FILESYSTEM
+ * <tt>(EROFS)</tt>
+ *
+ * @var FileError::Code FileError::TEXT_FILE_BUSY
+ * <tt>(ETXTBSY)</tt>
+ *
+ * @var FileError::Code FileError::FAULTY_ADDRESS
+ * <tt>(EFAULT)</tt>
+ *
+ * @var FileError::Code FileError::SYMLINK_LOOP
+ * <tt>(ELOOP)</tt>
+ *
+ * @var FileError::Code FileError::NO_SPACE_LEFT
+ * <tt>(ENOSPC)</tt>
+ *
+ * @var FileError::Code FileError::NOT_ENOUGH_MEMORY
+ * <tt>(ENOMEM)</tt>
+ *
+ * @var FileError::Code FileError::TOO_MANY_OPEN_FILES
+ * <tt>(EMFILE)</tt>
+ *
+ * @var FileError::Code FileError::FILE_TABLE_OVERFLOW
+ * <tt>(ENFILE)</tt>
+ *
+ * @var FileError::Code FileError::BAD_FILE_DESCRIPTOR
+ * <tt>(EBADF)</tt>
+ *
+ * @var FileError::Code FileError::INVALID_ARGUMENT
+ * <tt>(EINVAL)</tt>
+ *
+ * @var FileError::Code FileError::BROKEN_PIPE
+ * <tt>(EPIPE)</tt>
+ *
+ * @var FileError::Code FileError::TRYAGAIN
+ * <tt>(EAGAIN)</tt>
+ *
+ * We use TRYAGAIN instead of TRY_AGAIN, because that is defined as a macro by a Unix header.
+ *
+ * @var FileError::Code FileError::INTERRUPTED
+ * <tt>(EINTR)</tt>
+ *
+ * @var FileError::Code FileError::IO_ERROR
+ * <tt>(EIO)</tt>
+ *
+ * @var FileError::Code FileError::NOT_OWNER
+ * <tt>(EPERM)</tt>
+ *
+ * @var FileError::Code FileError::FAILED
+ * Returned if no specific code applies.
  */
 
 class Dir;


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]