reference: Add a note about search path ownership.

The current reference documentation of seed_engine_get_search_path()
does not specify whether the return value should be freed or not, and
that return value is not const so it's ambiguous.

https://bugzilla.gnome.org/show_bug.cgi?id=602032

diff --git a/libseed/seed-api.c b/libseed/seed-api.c
index 00b1c8b..e83c97d 100644 (file)
--- a/libseed/seed-api.c
+++ b/libseed/seed-api.c
@@ -622,7 +622,8 @@ seed_engine_set_search_path (SeedEngine * eng, const gchar * path)
  * seed_engine_get_search_path:
  * @eng: A #SeedEngine, to get the currently set search path.
  *
- * Retrieves the search path for the imports system.
+ * Retrieves the search path for the imports system. The returned value is
+ * owned by the #SeedEngine, and shouldn't be freed by the application writer.
  *
  * Return value: A null-terminated array of strings containing the paths.
  *