GNOME.org
 

[glib] docs: Fix broken gtk-doc formatting

commit e0e52b60ea4c65d1f3660ff6b8c547c82665036b
Author: Rico Tzschichholz <ricotz ubuntu com>
Date:   Mon Aug 18 14:08:41 2014 +0200

    docs: Fix broken gtk-doc formatting

 gio/fen/fen-kernel.c                 |    6 ++--
 gio/gdbusprivate.c                   |    4 +-
 gio/gfileattribute.c                 |   44 +++++++++++++++++-----------------
 gio/gresource.c                      |    2 +-
 gio/gunixmounts.c                    |    6 ++--
 gio/gwin32mount.c                    |    2 +-
 gio/gwin32volumemonitor.c            |    2 +-
 gio/kqueue/kqueue-thread.c           |   12 ++++----
 gio/tests/gdbus-threading.c          |    2 +-
 gio/tests/test-io-stream.c           |    2 +-
 gio/tests/test-pipe-unix.c           |    4 +-
 gio/win32/gwinhttpfile.c             |    2 +-
 gio/win32/gwinhttpfileinputstream.c  |    2 +-
 gio/win32/gwinhttpfileoutputstream.c |    2 +-
 gio/win32/gwinhttpvfs.c              |    2 +-
 15 files changed, 47 insertions(+), 47 deletions(-)
---
diff --git a/gio/fen/fen-kernel.c b/gio/fen/fen-kernel.c
index 8277fab..ed1e304 100644
--- a/gio/fen/fen-kernel.c
+++ b/gio/fen/fen-kernel.c
@@ -299,7 +299,7 @@ psource_new()
        return source;
 }
 
-/*
+/**
  * port_add:
  * @f:
  *
@@ -371,8 +371,8 @@ start_over:
     return errno;
 }
 
-/*
- * port_remove
+/**
+ * port_remove:
  *
  * < private >
  * Unsafe, need lock fen_lock.
diff --git a/gio/gdbusprivate.c b/gio/gdbusprivate.c
index 86a9d94..54659c1 100644
--- a/gio/gdbusprivate.c
+++ b/gio/gdbusprivate.c
@@ -1555,7 +1555,7 @@ continue_writing_in_idle_cb (gpointer user_data)
   return FALSE;
 }
 
-/*
+/**
  * @write_data: (transfer full) (allow-none):
  * @flush_data: (transfer full) (allow-none):
  * @close_data: (transfer full) (allow-none):
@@ -1908,7 +1908,7 @@ _g_dbus_debug_print_unlock (void)
   G_UNLOCK (print_lock);
 }
 
-/*
+/**
  * _g_dbus_initialize:
  *
  * Does various one-time init things such as
diff --git a/gio/gfileattribute.c b/gio/gfileattribute.c
index 98e11fe..09f01c0 100644
--- a/gio/gfileattribute.c
+++ b/gio/gfileattribute.c
@@ -135,7 +135,7 @@
  * where `nn` is a 2-digit hexadecimal number.
  */
 
-/*
+/**
  * _g_file_attribute_value_free:
  * @attr: a #GFileAttributeValue.
  *
@@ -151,7 +151,7 @@ _g_file_attribute_value_free (GFileAttributeValue *attr)
   g_free (attr);
 }
 
-/*
+/**
  * _g_file_attribute_value_clear:
  * @attr: a #GFileAttributeValue.
  *
@@ -178,7 +178,7 @@ _g_file_attribute_value_clear (GFileAttributeValue *attr)
   attr->type = G_FILE_ATTRIBUTE_TYPE_INVALID;
 }
 
-/*
+/**
  * g_file_attribute_value_set:
  * @attr: a #GFileAttributeValue to set the value in.
  * @new_value: a #GFileAttributeValue to get the value from.
@@ -207,7 +207,7 @@ _g_file_attribute_value_set (GFileAttributeValue        *attr,
     g_object_ref (attr->u.obj);
 }
 
-/*
+/**
  * _g_file_attribute_value_new:
  *
  * Creates a new file attribute.
@@ -240,7 +240,7 @@ _g_file_attribute_value_peek_as_pointer (GFileAttributeValue *attr)
   }
 }
 
-/*
+/**
  * g_file_attribute_value_dup:
  * @other: a #GFileAttributeValue to duplicate.
  *
@@ -314,7 +314,7 @@ escape_byte_string (const char *str)
     }
 }
 
-/*
+/**
  * _g_file_attribute_value_as_string:
  * @attr: a #GFileAttributeValue.
  *
@@ -384,7 +384,7 @@ _g_file_attribute_value_as_string (const GFileAttributeValue *attr)
   return str;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_string:
  * @attr: a #GFileAttributeValue.
  *
@@ -404,7 +404,7 @@ _g_file_attribute_value_get_string (const GFileAttributeValue *attr)
   return attr->u.string;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_byte_string:
  * @attr: a #GFileAttributeValue.
  *
@@ -435,7 +435,7 @@ _g_file_attribute_value_get_stringv (const GFileAttributeValue *attr)
   return attr->u.stringv;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_boolean:
  * @attr: a #GFileAttributeValue.
  *
@@ -455,7 +455,7 @@ _g_file_attribute_value_get_boolean (const GFileAttributeValue *attr)
   return attr->u.boolean;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_uint32:
  * @attr: a #GFileAttributeValue.
  *
@@ -475,7 +475,7 @@ _g_file_attribute_value_get_uint32 (const GFileAttributeValue *attr)
   return attr->u.uint32;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_int32:
  * @attr: a #GFileAttributeValue.
  *
@@ -495,7 +495,7 @@ _g_file_attribute_value_get_int32 (const GFileAttributeValue *attr)
   return attr->u.int32;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_uint64:
  * @attr: a #GFileAttributeValue.
  *
@@ -515,7 +515,7 @@ _g_file_attribute_value_get_uint64 (const GFileAttributeValue *attr)
   return attr->u.uint64;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_int64:
  * @attr: a #GFileAttributeValue.
  *
@@ -535,7 +535,7 @@ _g_file_attribute_value_get_int64 (const GFileAttributeValue *attr)
   return attr->u.int64;
 }
 
-/*
+/**
  * _g_file_attribute_value_get_object:
  * @attr: a #GFileAttributeValue.
  *
@@ -617,7 +617,7 @@ _g_file_attribute_value_set_from_pointer (GFileAttributeValue *value,
     }
 }
 
-/*
+/**
  * _g_file_attribute_value_set_string:
  * @attr: a #GFileAttributeValue.
  * @string: a UTF-8 string to set within the type.
@@ -636,7 +636,7 @@ _g_file_attribute_value_set_string (GFileAttributeValue *attr,
   attr->u.string = g_strdup (string);
 }
 
-/*
+/**
  * _g_file_attribute_value_set_byte_string:
  * @attr: a #GFileAttributeValue.
  * @string: a byte string to set within the type.
@@ -668,7 +668,7 @@ _g_file_attribute_value_set_stringv (GFileAttributeValue *attr,
 }
 
 
-/*
+/**
  * _g_file_attribute_value_set_boolean:
  * @attr: a #GFileAttributeValue.
  * @value: a #gboolean to set within the type.
@@ -686,7 +686,7 @@ _g_file_attribute_value_set_boolean (GFileAttributeValue *attr,
   attr->u.boolean = !!value;
 }
 
-/*
+/**
  * _g_file_attribute_value_set_uint32:
  * @attr: a #GFileAttributeValue.
  * @value: a #guint32 to set within the type.
@@ -704,7 +704,7 @@ _g_file_attribute_value_set_uint32 (GFileAttributeValue *attr,
   attr->u.uint32 = value;
 }
 
-/*
+/**
  * _g_file_attribute_value_set_int32:
  * @attr: a #GFileAttributeValue.
  * @value: a #gint32 to set within the type.
@@ -722,7 +722,7 @@ _g_file_attribute_value_set_int32 (GFileAttributeValue *attr,
   attr->u.int32 = value;
 }
 
-/*
+/**
  * _g_file_attribute_value_set_uint64:
  * @attr: a #GFileAttributeValue.
  * @value: a #guint64 to set within the type.
@@ -740,7 +740,7 @@ _g_file_attribute_value_set_uint64 (GFileAttributeValue *attr,
   attr->u.uint64 = value;
 }
 
-/*
+/**
  * _g_file_attribute_value_set_int64:
  * @attr: a #GFileAttributeValue.
  * @value: a #gint64 to set within the type.
@@ -758,7 +758,7 @@ _g_file_attribute_value_set_int64 (GFileAttributeValue *attr,
   attr->u.int64 = value;
 }
 
-/*
+/**
  * _g_file_attribute_value_set_object:
  * @attr: a #GFileAttributeValue.
  * @obj: a #GObject.
diff --git a/gio/gresource.c b/gio/gresource.c
index d9c1699..4e54fd2 100644
--- a/gio/gresource.c
+++ b/gio/gresource.c
@@ -179,7 +179,7 @@ g_resource_unref (GResource *resource)
     }
 }
 
-/*
+/**
  * g_resource_new_from_table:
  * @table: (transfer full): a GvdbTable
  *
diff --git a/gio/gunixmounts.c b/gio/gunixmounts.c
index 4999354..49c24ee 100644
--- a/gio/gunixmounts.c
+++ b/gio/gunixmounts.c
@@ -84,7 +84,7 @@ static const char *_resolve_dev_root (void);
  * file when using it.
  */
 
-/*
+/**
  * GUnixMountType:
  * @G_UNIX_MOUNT_TYPE_UNKNOWN: Unknown UNIX mount type.
  * @G_UNIX_MOUNT_TYPE_FLOPPY: Floppy disk UNIX mount type.
@@ -1867,7 +1867,7 @@ guess_mount_type (const char *mount_path,
   return type;
 }
 
-/*
+/**
  * g_unix_mount_guess_type:
  * @mount_entry: a #GUnixMount.
  * 
@@ -1889,7 +1889,7 @@ g_unix_mount_guess_type (GUnixMountEntry *mount_entry)
                           mount_entry->filesystem_type);
 }
 
-/*
+/**
  * g_unix_mount_point_guess_type:
  * @mount_point: a #GUnixMountPoint.
  * 
diff --git a/gio/gwin32mount.c b/gio/gwin32mount.c
index 5ae80c8..58986a1 100644
--- a/gio/gwin32mount.c
+++ b/gio/gwin32mount.c
@@ -117,7 +117,7 @@ _win32_get_displayname (const char *drive)
   return name ? name : g_strdup (drive);
 }
 
-/*
+/**
  * _g_win32_mount_new:
  * @volume_monitor: a #GVolumeMonitor.
  * @path: a win32 path.
diff --git a/gio/gwin32volumemonitor.c b/gio/gwin32volumemonitor.c
index 5e93699..ce8aaf7 100644
--- a/gio/gwin32volumemonitor.c
+++ b/gio/gwin32volumemonitor.c
@@ -46,7 +46,7 @@ G_DEFINE_TYPE_WITH_CODE (GWin32VolumeMonitor, g_win32_volume_monitor, G_TYPE_NAT
                                                         "win32",
                                                         0));
                                                         
-/*
+/**
  * get_viewable_logical_drives:
  *
  * Returns the list of logical and viewable drives as defined by
diff --git a/gio/kqueue/kqueue-thread.c b/gio/kqueue/kqueue-thread.c
index 231aac2..642b997 100644
--- a/gio/kqueue/kqueue-thread.c
+++ b/gio/kqueue/kqueue-thread.c
@@ -48,7 +48,7 @@ const uint32_t KQUEUE_VNODE_FLAGS =
 
 extern int get_kqueue_descriptor(void);
 
-/*
+/**
  * _kqueue_thread_collect_fds:
  * @events: a #kevents - the list of events to monitor. Will be extended
  *     with new items.
@@ -85,7 +85,7 @@ _kqueue_thread_collect_fds (kevents *events)
 }
 
 
-/*
+/**
  * _kqueue_thread_cleanup_fds:
  * @events: a #kevents -- list of events to monitor. Cancelled
  *     subscriptions will be removed from it, and its size
@@ -133,7 +133,7 @@ _kqueue_thread_cleanup_fds (kevents *events)
 }
 
 
-/*
+/**
  * _kqueue_thread_drop_fd:
  * @events: a #kevents -- list of events to monitor. Cancelled
  *     subscriptions will be removed from it, and its size
@@ -160,7 +160,7 @@ _kqueue_thread_drop_fd (kevents *events, int fd)
     } 
 }
 
-/*
+/**
  * _kqueue_thread_func:
  * @arg: a pointer to int -- control file descriptor.
  *
@@ -265,7 +265,7 @@ _kqueue_thread_func (void *arg)
 }
 
 
-/*
+/**
  * _kqueue_thread_push_fd:
  * @fd: a file descriptor
  *
@@ -284,7 +284,7 @@ _kqueue_thread_push_fd (int fd)
 }
 
 
-/*
+/**
  * _kqueue_thread_remove_fd:
  * @fd: a file descriptor
  *
diff --git a/gio/tests/gdbus-threading.c b/gio/tests/gdbus-threading.c
index ee9dbe9..c62b223 100644
--- a/gio/tests/gdbus-threading.c
+++ b/gio/tests/gdbus-threading.c
@@ -469,7 +469,7 @@ ensure_connection_works (GDBusConnection *conn)
   g_variant_unref (v);
 }
 
-/*
+/**
  * get_sync_in_thread:
  * @data: (type guint): delay in microseconds
  *
diff --git a/gio/tests/test-io-stream.c b/gio/tests/test-io-stream.c
index 7ab7f91..b79f62e 100644
--- a/gio/tests/test-io-stream.c
+++ b/gio/tests/test-io-stream.c
@@ -75,7 +75,7 @@ test_io_stream_class_init (TestIOStreamClass *klass)
   giostream_class->get_output_stream = test_io_stream_get_output_stream;
 }
 
-/*
+/**
  * test_io_stream_new:
  * @input_stream: an input stream
  * @output_stream: an output stream
diff --git a/gio/tests/test-pipe-unix.c b/gio/tests/test-pipe-unix.c
index 7b98044..3d75964 100644
--- a/gio/tests/test-pipe-unix.c
+++ b/gio/tests/test-pipe-unix.c
@@ -34,7 +34,7 @@
 #   error This module only exists on Unix
 #endif
 
-/*
+/**
  * test_pipe:
  * @is: (out) (allow-none): used to return a #GInputStream
  * @os: (out) (allow-none): used to return a #GOutputStream
@@ -80,7 +80,7 @@ test_pipe (GInputStream  **is,
   return TRUE;
 }
 
-/*
+/**
  * test_bidi_pipe:
  * @left: (out) (allow-none): used to return one #GIOStream
  * @right: (out) (allow-none): used to return the other #GIOStream
diff --git a/gio/win32/gwinhttpfile.c b/gio/win32/gwinhttpfile.c
index 160168d..a9fa5ab 100644
--- a/gio/win32/gwinhttpfile.c
+++ b/gio/win32/gwinhttpfile.c
@@ -75,7 +75,7 @@ g_winhttp_file_init (GWinHttpFile *winhttp)
 {
 }
 
-/*
+/**
  * _g_winhttp_file_new:
  * @vfs: GWinHttpVfs to use
  * @uri: URI of the GWinHttpFile to create.
diff --git a/gio/win32/gwinhttpfileinputstream.c b/gio/win32/gwinhttpfileinputstream.c
index 4842948..909300e 100644
--- a/gio/win32/gwinhttpfileinputstream.c
+++ b/gio/win32/gwinhttpfileinputstream.c
@@ -92,7 +92,7 @@ g_winhttp_file_input_stream_init (GWinHttpFileInputStream *info)
 {
 }
 
-/*
+/**
  * g_winhttp_file_input_stream_new:
  * @file: the GWinHttpFile being read
  * @connection: handle to the HTTP connection, as from WinHttpConnect()
diff --git a/gio/win32/gwinhttpfileoutputstream.c b/gio/win32/gwinhttpfileoutputstream.c
index d596a68..760a87a 100644
--- a/gio/win32/gwinhttpfileoutputstream.c
+++ b/gio/win32/gwinhttpfileoutputstream.c
@@ -81,7 +81,7 @@ g_winhttp_file_output_stream_init (GWinHttpFileOutputStream *info)
 {
 }
 
-/*
+/**
  * g_winhttp_file_output_stream_new:
  * @file: the GWinHttpFile being read
  * @connection: handle to the HTTP connection, as from WinHttpConnect()
diff --git a/gio/win32/gwinhttpvfs.c b/gio/win32/gwinhttpvfs.c
index dbe6af7..99d5228 100644
--- a/gio/win32/gwinhttpvfs.c
+++ b/gio/win32/gwinhttpvfs.c
@@ -139,7 +139,7 @@ g_winhttp_vfs_init (GWinHttpVfs *vfs)
   g_free (wagent);
 }
 
-/*
+/**
  * g_winhttp_vfs_new:
  *
  * Returns a new #GVfs handle for a WinHttp vfs.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]