Fix up includes in section docs

svn path=/trunk/; revision=6149

gio/ChangeLog

@@ -1,3 +1,7 @@
+2007-12-17  Matthias Clasen  <mclasen@redhat.com>
+
+	* *.c: Fix up includes in the section docs.
+
 2007-12-17  Alexander Larsson  <alexl@redhat.com>
 
         * gnativevolumemonitor.h:

gio/gappinfo.c

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

gio/gasynchelper.c

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

gio/gasyncresult.c

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

gio/gbufferedinputstream.c

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

gio/gbufferedoutputstream.c

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

gio/gcancellable.c

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

gio/gcontenttype.c

@@ -32,6 +32,7 @@
 /**
  * SECTION:gcontenttype
  * @short_description: Platform-specific content typing
+ * @include: gio.h
  *
  * 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

gio/gdatainputstream.c

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

gio/gdataoutputstream.c

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

gio/gdesktopappinfo.c

@@ -38,6 +38,16 @@
 
 #include "gioalias.h"
 
+/**
+ * SECTION:gdesktopappinfo
+ * @short_description: Application information from desktop files
+ * @include: gio/gdesktopappinfo.h 
+ * 
+ * #GDesktopAppInfo is an implementation of #GAppInfo based on
+ * desktop files.
+ *
+ **/
+
 #define DEFAULT_APPLICATIONS_GROUP  "Default Applications" 
 #define MIME_CACHE_GROUP            "MIME Cache"
 

gio/gdirectorymonitor.c

@@ -34,6 +34,7 @@
 /**
  * SECTION:gdirectorymonitor
  * @short_description: Directory Monitor
+ * @include: gio.h
  * @see_also: #GFileMonitor
  * 
  * Monitors a directory for changes to files in it.

gio/gdrive.c

@@ -31,7 +31,7 @@
 /**
  * SECTION:gdrive
  * @short_description: Virtual File System drive management
- * @include: gio/gdrive.h
+ * @include: gio.h
  * 
  * #GDrive is a container class for #GVolume objects that stem from
  * the same piece of media. As such, #GDrive abstracts a drive with

gio/gfile.c

@@ -40,8 +40,8 @@
 /**
  * SECTION:gfile
  * @short_description: File and Directory Handling
+ * @include: gio.h
  * @see_also: #GFileInfo, #GFileEnumerator
- * @include: gio/gfile.h
  * 
  * #GFile is a high level abstraction for manipulating files on a 
  * virtual file system. #GFile<!-- -->s are lightweight, immutable 

gio/gfileattribute.c

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

gio/gfileenumerator.c

@@ -32,20 +32,23 @@
 /**
  * SECTION:gfileenumerator
  * @short_description: Enumerated Files Routines
+ * @include: gio.h
  * 
- * #GFileEnumerator allows you to operate on a set of #GFile<!-- -->s, returning
+ * #GFileEnumerator allows you to operate on a set of #GFile<!-- -->s, 
- * a #GFileInfo structure for each file enumerated (e.g. g_file_enumerate_children() 
+ * returning a #GFileInfo structure for each file enumerated (e.g. 
- * will return a #GFileEnumerator for each of the children within a directory).
+ * g_file_enumerate_children() will return a #GFileEnumerator for each 
+ * of the children within a directory).
  *
  * To get the next file's information from a #GFileEnumerator, use 
  * g_file_enumerator_next_file() or its asynchronous version, 
- * g_file_enumerator_next_file_async(). Note that the asynchronous version will
+ * g_file_enumerator_next_file_async(). Note that the asynchronous 
- * return a list of #GFileInfo<!---->s, whereas the synchronous will only return 
+ * version will return a list of #GFileInfo<!---->s, whereas the 
- * the next file in the enumerator.
+ * synchronous will only return the next file in the enumerator.
  *
- * To close a #GFileEnumerator, use g_file_enumerator_close(), or its asynchronous 
+ * To close a #GFileEnumerator, use g_file_enumerator_close(), or 
- * version, g_file_enumerator_close_async(). Once a #GFileEnumerator is closed, 
+ * its asynchronous version, g_file_enumerator_close_async(). Once 
- * no further actions may be performed on it, and it should be freed with g_object_unref().
+ * a #GFileEnumerator is closed, no further actions may be performed 
+ * on it, and it should be freed with g_object_unref().
  * 
  **/ 
 

gio/gfileicon.c

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

gio/gfileinfo.c

@@ -23,6 +23,7 @@
 /**
  * SECTION:gfileinfo
  * @short_description: File Information and Attributes
+ * @include: gio.h
  * @see_also: #GFile
  * 
  * Functionality for manipulating basic metadata for files. #GFileInfo
@@ -30,9 +31,6 @@
  * contain, and allows for manipulation of extended attributes. 
  * #GFileAttributeMatcher allows for searching through a #GFileInfo for 
  * attributes.
- * 
- * 
- * 
  **/
 
 #include <config.h>

gio/gfileinputstream.c

@@ -33,9 +33,8 @@
 /**
  * SECTION:gfileinputstream
  * @short_description: File input streaming operations
+ * @include: gio.h
  * @see_also: #GInputStream, #GDataInputStream, #GSeekable
- * 
- * 
  *
  **/
 

gio/gfilemonitor.c

@@ -33,6 +33,7 @@
 /**
  * SECTION:gfilemonitor
  * @short_description: File Monitor
+ * @include: gio.h
  * @see_also: #GDirectoryMonitor
  *
  * Monitors a file for changes.

gio/gfilenamecompleter.c

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

gio/gfileoutputstream.c

@@ -33,9 +33,9 @@
 /**
  * SECTION:gfileoutputstream
  * @short_description: File output streaming operations
+ * @include: gio.h
  * @see_also: #GOutputStream, #GDataOutputStream, #GSeekable
  * 
- * 
  *
  **/
 

gio/gfilterinputstream.c

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

gio/gfilteroutputstream.c

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

gio/gicon.c

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

gio/ginputstream.c

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

gio/gioerror.c

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

gio/giomodule.c

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

gio/gioscheduler.c

@@ -29,9 +29,11 @@
 /**
  * SECTION:gioscheduler
  * @short_description: I/O Scheduler
+ * @include: gio.h
  * 
- * Schedules asynchronous I/O operations. #GIOScheduler integrates into the main 
+ * Schedules asynchronous I/O operations. #GIOScheduler integrates 
- * event loop (#GMainLoop) and may use threads if they are available.
+ * into the main event loop (#GMainLoop) and may use threads if they 
+ * are available.
  * 
  * <para id="io-priority"><indexterm><primary>I/O priority</primary></indexterm>
  * Each I/O operation has a priority, and the scheduler uses the priorities

gio/gloadableicon.c

@@ -30,9 +30,11 @@
 /**
  * SECTION:gloadableicon
  * @short_description: Loadable Icons
+ * @include: gio.h
  * @see_also: #GIcon, #GThemedIcon
  * 
- * Extends the #GIcon interface and adds the ability to load icons from streams.
+ * Extends the #GIcon interface and adds the ability to 
+ * load icons from streams.
  **/
 
 static void          g_loadable_icon_real_load_async  (GLoadableIcon        *icon,

gio/gmemoryinputstream.c

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

gio/gmemoryoutputstream.c

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

gio/gmount.c

@@ -36,11 +36,11 @@
 
 /**
  * SECTION:gmount
- * @short_description: mount management
+ * @short_description: Mount management
+ * @include: gio.h
  * 
- * The #GMount interface represents user-visible mounts. Note, when
+ * The #GMount interface represents user-visible mounts. Note, when 
- * porting from GnomeVFS, #GMount is the moral equivalent of
+ * porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume.
- * #GnomeVFSVolume.
  * 
  * Unmounting a #GMount instance is an asynchronous operation. For
  * more information about asynchronous operations, see #GAsyncReady
@@ -51,9 +51,8 @@
  * #GAsyncReady structure will be passed to the callback.  That
  * callback should then call g_mount_unmount_finish() with the #GMount
  * and the #GAsyncReady data to see if the operation was completed
- * successfully.  If an @error is present when
+ * successfully.  If an @error is present when g_mount_unmount_finish() 
- * g_mount_unmount_finish() is called, then it will be filled with any
+ * is called, then it will be filled with any error information.
- * error information.
  **/
 
 static void g_mount_base_init (gpointer g_class);

gio/gmountoperation.c

@@ -34,16 +34,17 @@
 /** 
  * SECTION:gmountoperation
  * @short_description: Authentication methods for mountable locations
+ * @include: gio.h
  *
  * #GMountOperation provides a mechanism for authenticating mountable 
  * operations, such as loop mounting files, hard drive partitions or 
  * server locations. 
  *
- * Mountin operations are handed a #GMountOperation that then can use if they 
+ * Mounting operations are handed a #GMountOperation that then can use 
- * require any privileges or authentication for their volumes to be 
+ * if they require any privileges or authentication for their volumes 
- * mounted (e.g. a hard disk partition or an encrypted filesystem), or 
+ * to be mounted (e.g. a hard disk partition or an encrypted filesystem), 
- * if they are implementing a remote server protocol which requires user
+ * or if they are implementing a remote server protocol which requires 
- * credentials such as FTP or WebDAV.
+ * user credentials such as FTP or WebDAV.
  *
  * Users should instantiate a subclass of this that implements all
  * the various callbacks to show the required dialogs.

gio/goutputstream.c

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

gio/gseekable.c

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

gio/gsimpleasyncresult.c

@@ -41,6 +41,7 @@
 /**
  * SECTION:gsimpleasyncresult
  * @short_description: Simple asynchronous results implementation
+ * @include: gio.h
  * @see_also: #GAsyncResult
  *
  * Implements #GAsyncResult for simple cases. Most of the time, this 
@@ -48,24 +49,25 @@
  * Because of this, #GSimpleAsyncResult is used throughout GIO for 
  * handling asynchronous functions. 
  * 
- * GSimpleAsyncResult handles #GAsyncReadyCallback<!-- -->s, error reporting,
+ * GSimpleAsyncResult handles #GAsyncReadyCallback<!-- -->s, error 
- * operation cancellation and the final state of an operation, completely
+ * reporting, operation cancellation and the final state of an operation, 
- * transparent to the application. Results can be returned as a pointer e.g. 
+ * completely transparent to the application. Results can be returned 
- * for functions that return data that is collected asynchronously,
+ * as a pointer e.g. for functions that return data that is collected 
- * a boolean value for checking the success or failure of an operation,
+ * asynchronously, a boolean value for checking the success or failure 
- * or a #gssize for operations which return the number of bytes modified 
+ * of an operation, or a #gssize for operations which return the number 
- * by the operation; all of the simple return cases are covered.
+ * of bytes modified by the operation; all of the simple return cases 
+ * are covered.
  * 
  * Most of the time, an application will not need to know of the details 
- * of this API; it is handled transparently, and any necessary operations are 
+ * of this API; it is handled transparently, and any necessary operations 
- * handled by #GAsyncResult's interface. However, if implementing a new GIO 
+ * are handled by #GAsyncResult's interface. However, if implementing a 
- * module, for writing language bindings, or for complex applications that 
+ * new GIO module, for writing language bindings, or for complex 
- * need better control of how asynchronous operations are completed, it is 
+ * applications that need better control of how asynchronous operations 
- * important to understand this functionality.
+ * are completed, it is important to understand this functionality.
  * 
- * GSimpleAsyncResults are tagged with the calling function to ensure that 
+ * GSimpleAsyncResults are tagged with the calling function to ensure 
- * asynchronous functions and their finishing functions are used together 
+ * that asynchronous functions and their finishing functions are used 
- * correctly.
+ * together correctly.
  * 
  * To create a new #GSimpleAsyncResult, call g_simple_async_result_new(). 
  * If the result needs to be created for a #GError, use 
@@ -81,8 +83,8 @@
  * calling g_simple_async_result_set_handle_cancellation() with a 
  * #GSimpleAsyncResult for the operation and %FALSE. 
  * 
- * GSimpleAsyncResult can integrate into GLib's Main Event Loop 
+ * GSimpleAsyncResult can integrate into GLib's event loop, #GMainLoop, 
- * <!-- TODO: Crosslink -->, or it can use #GThread<!-- -->s if available. 
+ * or it can use #GThread<!-- -->s if available. 
  * g_simple_async_result_complete() will finish an I/O task directly within 
  * the main event loop. g_simple_async_result_complete_in_idle() will 
  * integrate the I/O task into the main event loop as an idle function and 

gio/gthemedicon.c

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

gio/gunixinputstream.c

@@ -44,6 +44,7 @@
 /**
  * SECTION:gunixinputstream
  * @short_description: Streaming input operations for Unix file descriptors
+ * @include: gio/gunixinputstream.h
  * @see_also: #GInputStream
  *
  * #GUnixInputStream implements #GInputStream for reading from a

gio/gunixmounts.c

@@ -57,6 +57,7 @@ static const char *_resolve_dev_root (void);
 
 /**
  * SECTION:gunixmounts
+ * @include: gio/gunixmounts.h
  * @short_description: Unix Mounts
  * 
  * Routines for managing mounted UNIX mount points and paths.

gio/gunixoutputstream.c

@@ -44,6 +44,7 @@
 /**
  * SECTION:gunixoutputstream
  * @short_description: Streaming output operations for Unix file descriptors
+ * @include: gio/gunixoutputstream.h
  * @see_also: #GOutputStream
  *
  * #GUnixOutputStream implements #GOutputStream for writing to a a

gio/gvfs.c

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

gio/gvolume.c

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

gio/gvolumemonitor.c

@@ -30,6 +30,7 @@
 /**
  * SECTION:gvolumemonitor
  * @short_description: Volume Monitor
+ * @include: gio.h
  * @see_also: #GDirectoryMonitor, #GFileMonitor
  * 
  * Monitors a mounted volume for changes.