Uncomment GTKMM_DOXYGEN_INPUT_SUBDIRS to fix the reference documentation

2008-01-08  Murray Cumming  <murrayc@murrayc.com>

* configure.in: Uncomment GTKMM_DOXYGEN_INPUT_SUBDIRS to fix the 
reference documentation build (no idea when this happened) and add 
gio to the list of directories.

* glib/src/optioncontext.ccg:
* glib/src/optioncontext.hg: Added get_help().

* gio/src/gio_enums.defs: Regenerated with enums.pl
* gio/src/gio_methods.defs: Regenerated with h2defs.py.

* tools/m4/convert_glib.m4:
* gio/src/fileattribute.hg: Renamed FileAttributeFlags to 
FileAttributeInfoFlags, as it is in gio.

* gio/src/fileenumerator.hg:
* gio/src/asyncresult.hg:
* gio/src/cancellable.hg:
* gio/src/drive.hg:
* gio/src/file.hg: Added class documentation, and some method 
documentation, based on the C documentation.
Many giomm classes still need documentation.

svn path=/trunk/; revision=492

1 files changed, 19 insertions, 1 deletions

diff --git a/gio/src/drive.hg b/gio/src/drive.hg
index e30f5bc3..e3292692 100644
--- a/gio/src/drive.hg
+++ b/gio/src/drive.hg
@@ -31,6 +31,16 @@ _PINCLUDE(glibmm/private/interface_p.h)
 namespace Gio
 {
 
+/** Virtual File System drive management.
+ *
+ * This represent a piece of hardware connected to the machine. It's generally only created for removable hardware or hardware with removable media.
+ * Gio::Drive is a container class for Gio::Volume objects that stem from the same piece of media. As such, Gio::Drive abstracts a drive with 
+ * (or without) removable media and provides operations for querying whether media is available, determing whether media change is automatically 
+ * detected and ejecting the media.
+ *
+ * If the Gio::Drive reports that media isn't automatically detected, one can poll for media; typically one should not do this periodically as a 
+ * poll for media operation is potententially expensive and may spin up the drive, creating noise.
+ */
 class Drive : public Glib::Interface
 {
   _CLASS_INTERFACE(Drive, GDrive, G_DRIVE, GDriveIface)
@@ -50,11 +60,19 @@ public:
   // TODO: get_volumes, returns a list of GVolumes, we shouldn't take copy
   // as these are owned by the volume monitor
 
-  _IGNORE(g_drive_eject)
+
+  /** Ejects the drive.
+   * @param cancellable A cancellable object which can be used to cancel the eject.
+   * @param slot A callback which will be called when the eject is completed or canceled.
+   */
   void eject(const Glib::RefPtr<Cancellable>& cancellable,
              const SlotAsyncReady& slot);
 
+  /** Ejects the drive.
+   * @param slot A callback which will be called when the eject is completed.
+   */
   void eject(const SlotAsyncReady& slot);
+  _IGNORE(g_drive_eject)
 
   _WRAP_METHOD(bool eject_finish(Glib::RefPtr<AsyncResult>& result),
                g_drive_eject_finish,