Doc fixes

svn path=/trunk/; revision=6554
This commit is contained in:
Matthias Clasen 2008-02-21 18:20:17 +00:00
parent 31723eb78e
commit f3144c7efe
39 changed files with 43 additions and 39 deletions

View File

@ -1,3 +1,7 @@
2008-02-21 Matthias Clasen <mclasen@redhat.com>
* *.c: Correct the @include in for section docs.
2008-02-21 David Zeuthen <davidz@redhat.com> 2008-02-21 David Zeuthen <davidz@redhat.com>
* glocalfileinfo.c: (_g_local_file_info_get): * glocalfileinfo.c: (_g_local_file_info_get):

View File

@ -31,7 +31,7 @@
/** /**
* SECTION:gappinfo * SECTION:gappinfo
* @short_description: Application information and launch contexts * @short_description: Application information and launch contexts
* @include: gio.h * @include: gio/gio.h
* *
* #GAppInfo and #GAppLaunchContext are used for describing and launching * #GAppInfo and #GAppLaunchContext are used for describing and launching
* applications installed on the system. * applications installed on the system.

View File

@ -29,7 +29,7 @@
/** /**
* SECTION:gasynchelper * SECTION:gasynchelper
* @short_description: Asynchronous Helper Functions * @short_description: Asynchronous Helper Functions
* @include: gio.h * @include: gio/gio.h
* @see_also: #GAsyncReady * @see_also: #GAsyncReady
* *
* Provides helper functions for asynchronous operations. * Provides helper functions for asynchronous operations.

View File

@ -29,7 +29,7 @@
/** /**
* SECTION:gasyncresult * SECTION:gasyncresult
* @short_description: Asynchronous Function Results * @short_description: Asynchronous Function Results
* @include: gio.h * @include: gio/gio.h
* @see_also: #GSimpleAsyncResult * @see_also: #GSimpleAsyncResult
* *
* Provides a base class for implementing asynchronous function results. * Provides a base class for implementing asynchronous function results.

View File

@ -33,7 +33,7 @@
/** /**
* SECTION:gbufferedinputstream * SECTION:gbufferedinputstream
* @short_description: Buffered Input Stream * @short_description: Buffered Input Stream
* @include: gio.h * @include: gio/gio.h
* @see_also: #GFilterInputStream, #GInputStream * @see_also: #GFilterInputStream, #GInputStream
* *
* Buffered input stream implements #GFilterInputStream and provides * Buffered input stream implements #GFilterInputStream and provides

View File

@ -32,7 +32,7 @@
/** /**
* SECTION:gbufferedoutputstream * SECTION:gbufferedoutputstream
* @short_description: Buffered Output Stream * @short_description: Buffered Output Stream
* @include: gio.h * @include: gio/gio.h
* @see_also: #GFilterOutputStream, #GOutputStream * @see_also: #GFilterOutputStream, #GOutputStream
* *
* Buffered output stream implements #GFilterOutputStream and provides * Buffered output stream implements #GFilterOutputStream and provides

View File

@ -40,7 +40,7 @@
/** /**
* SECTION:gcancellable * SECTION:gcancellable
* @short_description: Thread-safe Operation Cancellation Stack * @short_description: Thread-safe Operation Cancellation Stack
* @include: gio.h * @include: gio/gio.h
* *
* GCancellable is a thread-safe operation cancellation stack used * GCancellable is a thread-safe operation cancellation stack used
* throughout GIO to allow for cancellation of synchronous and * throughout GIO to allow for cancellation of synchronous and

View File

@ -35,7 +35,7 @@
/** /**
* SECTION:gcontenttype * SECTION:gcontenttype
* @short_description: Platform-specific content typing * @short_description: Platform-specific content typing
* @include: gio.h * @include: gio/gio.h
* *
* A content type is a platform specific string that defines the type * A content type is a platform specific string that defines the type
* of a file. On unix it is a mime type, on win32 it is an extension string * of a file. On unix it is a mime type, on win32 it is an extension string

View File

@ -31,7 +31,7 @@
/** /**
* SECTION:gdatainputstream * SECTION:gdatainputstream
* @short_description: Data Input Stream * @short_description: Data Input Stream
* @include: gio.h * @include: gio/gio.h
* @see_also: #GInputStream * @see_also: #GInputStream
* *
* Data input stream implements #GInputStream and includes functions for * Data input stream implements #GInputStream and includes functions for

View File

@ -31,7 +31,7 @@
/** /**
* SECTION:gdataoutputstream * SECTION:gdataoutputstream
* @short_description: Data Output Stream * @short_description: Data Output Stream
* @include: gio.h * @include: gio/gio.h
* @see_also: #GOutputStream * @see_also: #GOutputStream
* *
* Data output stream implements #GOutputStream and includes functions for * Data output stream implements #GOutputStream and includes functions for

View File

@ -31,7 +31,7 @@
/** /**
* SECTION:gdrive * SECTION:gdrive
* @short_description: Virtual File System drive management * @short_description: Virtual File System drive management
* @include: gio.h * @include: gio/gio.h
* *
* #GDrive - this represent a piece of hardware connected to the machine. * #GDrive - this represent a piece of hardware connected to the machine.
* Its generally only created for removable hardware or hardware with * Its generally only created for removable hardware or hardware with

View File

@ -42,7 +42,7 @@
/** /**
* SECTION:gfile * SECTION:gfile
* @short_description: File and Directory Handling * @short_description: File and Directory Handling
* @include: gio.h * @include: gio/gio.h
* @see_also: #GFileInfo, #GFileEnumerator * @see_also: #GFileInfo, #GFileEnumerator
* *
* #GFile is a high level abstraction for manipulating files on a * #GFile is a high level abstraction for manipulating files on a
@ -59,7 +59,7 @@
* g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name(). * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name().
* *
* One way to think of a #GFile is as an abstraction of a pathname. For normal * One way to think of a #GFile is as an abstraction of a pathname. For normal
* files the system pathname is what is stored interanally, but as #GFile<!-- -->s * files the system pathname is what is stored internally, but as #GFile<!-- -->s
* are extensible it could also be something else that corresponds to a pathname * are extensible it could also be something else that corresponds to a pathname
* in a userspace implementation of a filesystem. * in a userspace implementation of a filesystem.
* *

View File

@ -34,7 +34,7 @@
/** /**
* SECTION:gfileattribute * SECTION:gfileattribute
* @short_description: Key-Value Paired File Attributes * @short_description: Key-Value Paired File Attributes
* @include: gio.h * @include: gio/gio.h
* @see_also: #GFile, #GFileInfo * @see_also: #GFile, #GFileInfo
* *
* File attributes in GIO consist of a list of key-value pairs. * File attributes in GIO consist of a list of key-value pairs.

View File

@ -32,7 +32,7 @@
/** /**
* SECTION:gfileenumerator * SECTION:gfileenumerator
* @short_description: Enumerated Files Routines * @short_description: Enumerated Files Routines
* @include: gio.h * @include: gio/gio.h
* *
* #GFileEnumerator allows you to operate on a set of #GFile<!-- -->s, * #GFileEnumerator allows you to operate on a set of #GFile<!-- -->s,
* returning a #GFileInfo structure for each file enumerated (e.g. * returning a #GFileInfo structure for each file enumerated (e.g.

View File

@ -30,7 +30,7 @@
/** /**
* SECTION:gfileicon * SECTION:gfileicon
* @short_description: Icons pointing to an image file * @short_description: Icons pointing to an image file
* @include: gio.h * @include: gio/gio.h
* @see_also: #GIcon, #GLoadableIcon * @see_also: #GIcon, #GLoadableIcon
* *
* #GFileIcon specifies an icon by pointing to an image file * #GFileIcon specifies an icon by pointing to an image file

View File

@ -23,7 +23,7 @@
/** /**
* SECTION:gfileinfo * SECTION:gfileinfo
* @short_description: File Information and Attributes * @short_description: File Information and Attributes
* @include: gio.h * @include: gio/gio.h
* @see_also: #GFile, <link linkend="gio-GFileAttribute">GFileAttribute</link> * @see_also: #GFile, <link linkend="gio-GFileAttribute">GFileAttribute</link>
* *
* Functionality for manipulating basic metadata for files. #GFileInfo * Functionality for manipulating basic metadata for files. #GFileInfo

View File

@ -33,7 +33,7 @@
/** /**
* SECTION:gfileinputstream * SECTION:gfileinputstream
* @short_description: File input streaming operations * @short_description: File input streaming operations
* @include: gio.h * @include: gio/gio.h
* @see_also: #GInputStream, #GDataInputStream, #GSeekable * @see_also: #GInputStream, #GDataInputStream, #GSeekable
* *
* GFileInputStream provides input streams that take their * GFileInputStream provides input streams that take their

View File

@ -34,7 +34,7 @@
/** /**
* SECTION:gfilemonitor * SECTION:gfilemonitor
* @short_description: File Monitor * @short_description: File Monitor
* @include: gio.h * @include: gio/gio.h
* *
* Monitors a file or directory for changes. * Monitors a file or directory for changes.
* *

View File

@ -32,7 +32,7 @@
/** /**
* SECTION:gfilenamecompleter * SECTION:gfilenamecompleter
* @short_description: Filename Completer * @short_description: Filename Completer
* @include: gio.h * @include: gio/gio.h
* *
* Completes partial file and directory names given a partial string by * Completes partial file and directory names given a partial string by
* looking in the file system for clues. Can return a list of possible * looking in the file system for clues. Can return a list of possible

View File

@ -33,7 +33,7 @@
/** /**
* SECTION:gfileoutputstream * SECTION:gfileoutputstream
* @short_description: File output streaming operations * @short_description: File output streaming operations
* @include: gio.h * @include: gio/gio.h
* @see_also: #GOutputStream, #GDataOutputStream, #GSeekable * @see_also: #GOutputStream, #GDataOutputStream, #GSeekable
* *
* GFileOutputStream provides output streams that write their * GFileOutputStream provides output streams that write their

View File

@ -30,7 +30,7 @@
/** /**
* SECTION:gfilterinputstream * SECTION:gfilterinputstream
* @short_description: Filter Input Stream * @short_description: Filter Input Stream
* @include: gio.h * @include: gio/gio.h
* *
**/ **/

View File

@ -30,7 +30,7 @@
/** /**
* SECTION:gfilteroutputstream * SECTION:gfilteroutputstream
* @short_description: Filter Output Stream * @short_description: Filter Output Stream
* @include: gio.h * @include: gio/gio.h
* *
**/ **/

View File

@ -30,7 +30,7 @@
/** /**
* SECTION:gicon * SECTION:gicon
* @short_description: Interface for icons * @short_description: Interface for icons
* @include: gio.h * @include: gio/gio.h
* *
* #GIcon is a very minimal interface for icons. It provides functions * #GIcon is a very minimal interface for icons. It provides functions
* for checking the equality of two icons and hashing of icons. * for checking the equality of two icons and hashing of icons.

View File

@ -33,7 +33,7 @@
/** /**
* SECTION:ginputstream * SECTION:ginputstream
* @short_description: Base class for implementing streaming input * @short_description: Base class for implementing streaming input
* @include: gio.h * @include: gio/gio.h
* *
* *
* *

View File

@ -29,7 +29,7 @@
/** /**
* SECTION:gioerror * SECTION:gioerror
* @short_description: Error helper functions * @short_description: Error helper functions
* @include: gio.h * @include: gio/gio.h
* *
* Contains helper functions for reporting errors to the user. * Contains helper functions for reporting errors to the user.
**/ **/

View File

@ -38,7 +38,7 @@
/** /**
* SECTION:giomodule * SECTION:giomodule
* @short_description: Loadable GIO Modules * @short_description: Loadable GIO Modules
* @include: gio.h * @include: gio/gio.h
* *
* Provides an interface and default functions for loading and unloading * Provides an interface and default functions for loading and unloading
* modules. This is used internally to make GIO extensible, but can also * modules. This is used internally to make GIO extensible, but can also

View File

@ -29,7 +29,7 @@
/** /**
* SECTION:gioscheduler * SECTION:gioscheduler
* @short_description: I/O Scheduler * @short_description: I/O Scheduler
* @include: gio.h * @include: gio/gio.h
* *
* Schedules asynchronous I/O operations. #GIOScheduler integrates * Schedules asynchronous I/O operations. #GIOScheduler integrates
* into the main event loop (#GMainLoop) and may use threads if they * into the main event loop (#GMainLoop) and may use threads if they

View File

@ -30,7 +30,7 @@
/** /**
* SECTION:gloadableicon * SECTION:gloadableicon
* @short_description: Loadable Icons * @short_description: Loadable Icons
* @include: gio.h * @include: gio/gio.h
* @see_also: #GIcon, #GThemedIcon * @see_also: #GIcon, #GThemedIcon
* *
* Extends the #GIcon interface and adds the ability to * Extends the #GIcon interface and adds the ability to

View File

@ -33,7 +33,7 @@
/** /**
* SECTION:gmemoryinputstream * SECTION:gmemoryinputstream
* @short_description: Streaming input operations on memory chunks * @short_description: Streaming input operations on memory chunks
* @include: gio.h * @include: gio/gio.h
* @see_also: #GMemoryOutputStream * @see_also: #GMemoryOutputStream
* *
* #GMemoryInputStream is a class for using arbitrary * #GMemoryInputStream is a class for using arbitrary

View File

@ -33,7 +33,7 @@
/** /**
* SECTION:gmemoryoutputstream * SECTION:gmemoryoutputstream
* @short_description: Streaming output operations on memory chunks * @short_description: Streaming output operations on memory chunks
* @include: gio.h * @include: gio/gio.h
* @see_also: #GMemoryInputStream * @see_also: #GMemoryInputStream
* *
* #GMemoryOutputStream is a class for using arbitrary * #GMemoryOutputStream is a class for using arbitrary

View File

@ -37,7 +37,7 @@
/** /**
* SECTION:gmount * SECTION:gmount
* @short_description: Mount management * @short_description: Mount management
* @include: gio.h * @include: gio/gio.h
* @see also: GVolume, GUnixMount * @see also: GVolume, GUnixMount
* *
* The #GMount interface represents user-visible mounts. Note, when * The #GMount interface represents user-visible mounts. Note, when

View File

@ -34,7 +34,7 @@
/** /**
* SECTION:gmountoperation * SECTION:gmountoperation
* @short_description: Authentication methods for mountable locations * @short_description: Authentication methods for mountable locations
* @include: gio.h * @include: gio/gio.h
* *
* #GMountOperation provides a mechanism for authenticating mountable * #GMountOperation provides a mechanism for authenticating mountable
* operations, such as loop mounting files, hard drive partitions or * operations, such as loop mounting files, hard drive partitions or

View File

@ -30,7 +30,7 @@
/** /**
* SECTION:goutputstream * SECTION:goutputstream
* @short_description: Base class for implementing streaming output * @short_description: Base class for implementing streaming output
* @include: gio.h * @include: gio/gio.h
* *
* *
**/ **/

View File

@ -29,7 +29,7 @@
/** /**
* SECTION:gseekable * SECTION:gseekable
* @short_description: Stream seeking interface * @short_description: Stream seeking interface
* @include: gio.h * @include: gio/gio.h
* @see_also: #GInputStream, #GOutputStream * @see_also: #GInputStream, #GOutputStream
* *
* #GSeekable is implemented by streams (implementations of * #GSeekable is implemented by streams (implementations of

View File

@ -41,7 +41,7 @@
/** /**
* SECTION:gsimpleasyncresult * SECTION:gsimpleasyncresult
* @short_description: Simple asynchronous results implementation * @short_description: Simple asynchronous results implementation
* @include: gio.h * @include: gio/gio.h
* @see_also: #GAsyncResult * @see_also: #GAsyncResult
* *
* Implements #GAsyncResult for simple cases. Most of the time, this * Implements #GAsyncResult for simple cases. Most of the time, this

View File

@ -31,7 +31,7 @@
/** /**
* SECTION:gthemedicon * SECTION:gthemedicon
* @short_description: Icon theming support * @short_description: Icon theming support
* @include: gio.h * @include: gio/gio.h
* @see_also: #GIcon, #GLoadableIcon * @see_also: #GIcon, #GLoadableIcon
* *
* #GThemedIcon is an implementation of #GIcon that supports icon themes. * #GThemedIcon is an implementation of #GIcon that supports icon themes.

View File

@ -32,7 +32,7 @@
/** /**
* SECTION:gvfs * SECTION:gvfs
* @short_description: Virtual File System * @short_description: Virtual File System
* @include: gio.h * @include: gio/gio.h
* *
* Entry point for using GIO functionality. * Entry point for using GIO functionality.
* *

View File

@ -32,7 +32,7 @@
/** /**
* SECTION:gvolume * SECTION:gvolume
* @short_description: Volume management * @short_description: Volume management
* @include: gio.h * @include: gio/gio.h
* *
* The #GVolume interface represents user-visible objects that can be * The #GVolume interface represents user-visible objects that can be
* mounted. Note, when porting from GnomeVFS, #GVolume is the moral * mounted. Note, when porting from GnomeVFS, #GVolume is the moral

View File

@ -32,7 +32,7 @@
/** /**
* SECTION:gvolumemonitor * SECTION:gvolumemonitor
* @short_description: Volume Monitor * @short_description: Volume Monitor
* @include: gio.h * @include: gio/gio.h
* @see_also: #GFileMonitor * @see_also: #GFileMonitor
* *
* #GVolumeMonitor is for listing the user interesting devices and volumes * #GVolumeMonitor is for listing the user interesting devices and volumes