Fix build breakage due to comments in documentation

2 files changed, 52 insertions, 0 deletions

diff --git a/ChangeLog b/ChangeLog
index 18157769..7edfd842 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2009-05-18  Jonathon Jongsma  <jonathon@quotidian.org>
+
+	* gio/src/gio_docs_override.xml:add an override for
+	get_activation_root() since the documentation contains /* comments
+	*/ that mess up the documetation comments
+
 2009-05-16  Jonathon Jongsma  <jonathon@quotidian.org>
 
 	* gio/src/cancellable.ccg:
diff --git a/gio/src/gio_docs_override.xml b/gio/src/gio_docs_override.xml
index 4ab66551..d06bd060 100644
--- a/gio/src/gio_docs_override.xml
+++ b/gio/src/gio_docs_override.xml
@@ -1733,5 +1733,51 @@ errors that can happen due to races when you execute the operation.
 </return>
 </function>
 
+<function name="g_volume_get_activation_root">
+<description>
+Gets the activation root for a #GVolume if it is known ahead of
+mount time. Returns %NULL otherwise. If not %NULL and if @volume
+is mounted, then the result of g_mount_get_root() on the
+#GMount object obtained from g_volume_get_mount() will always
+either be equal or a prefix of what this function returns. In
+other words, in code
+
+&lt;programlisting&gt;
+GMount *mount;
+GFile *mount_root
+GFile *volume_activation_root;
+
+mount = g_volume_get_mount (volume); // mounted, so never NULL
+mount_root = g_mount_get_root (mount);
+volume_activation_root = g_volume_get_activation_root(volume); // assume not NULL
+&lt;/programlisting&gt;
+
+then the expression
+
+&lt;programlisting&gt;
+(g_file_has_prefix (volume_activation_root, mount_root) ||
+      g_file_equal (volume_activation_root, mount_root))
+&lt;/programlisting&gt;
+
+will always be %TRUE.
+
+Activation roots are typically used in #GVolumeMonitor
+implementations to find the underlying mount to shadow, see
+g_mount_is_shadowed() for more details.
+
+
+</description>
+<parameters>
+<parameter name="volume">
+<parameter_description> a #GVolume
+</parameter_description>
+</parameter>
+</parameters>
+<return> the activation root of @volume or %NULL. Use
+g_object_unref() to free.
+
+Since: 2.18
+</return>
+</function>
 
 </root>