Doc fixes



I've attached a patch with three small doc fixes:

-Explicitly state that an iterator points to the first element when
instantiated. Unless the behaviour should be undefined, I think we
should point that out. The assumption is used a lot of places anyway.

-Explicitly use "shallow copy" in description of tny_list_copy. For
techies, that can be clearer than "It doesn't copy the items".

-Remove small mistake in example (one parameter too much)

Please think a moment about the first bullet.

Cheers,
Øystein
Index: libtinymail/tny-folder-store.c
===================================================================
--- libtinymail/tny-folder-store.c	(revisjon 1319)
+++ libtinymail/tny-folder-store.c	(arbeidskopi)
@@ -167,7 +167,7 @@
  *     TnyList *folders;
  *     folders = tny_simple_list_new ();
  *     tny_folder_store_get_folders_async (TNY_FOLDER_STORE (account),
- *         folders, callback, NULL, NULL, NULL);
+ *         folders, callback, NULL, NULL);
  * }
  * </programlisting></informalexample>
  *
Index: libtinymail/tny-list.c
===================================================================
--- libtinymail/tny-list.c	(revisjon 1319)
+++ libtinymail/tny-list.c	(arbeidskopi)
@@ -194,7 +194,8 @@
  * tny_list_create_iterator:
  * @self: A #TnyList instance
  *
- * Creates a new iterator instance for the list. 
+ * Creates a new iterator instance for the list. The initial position
+ * of the iterator is the first element.
  *
  * An iterator is a position indicator for a list. It keeps the position
  * state of a list iteration. The list itself does not keep any position 
@@ -300,11 +301,12 @@
  * tny_list_copy:
  * @self: A #TnyList instance
  *
- * Creates a copy of the list. It doesn't copy the items. It, however, creates
- * a new list with new references to the same items. The items will get an extra
- * reference added for the new list being their second parent, setting their
- * reference count to for example two. Which means that both lists (the original
- * and the copy) must be unreferenced after use.
+ * Creates a shallow copy of the list. It doesn't copy the items. It,
+ * however, creates a new list with new references to the same
+ * items. The items will get an extra reference added for the new list
+ * being their second parent, setting their reference count to for
+ * example two. Which means that both lists (the original and the
+ * copy) must be unreferenced after use.
  *
  * Return value: A copy of this list
  *


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]