SF.net SVN: geany:[4018] trunk/src/document.c

[ntrel at users.sourceforge.net]

Revision: 4018
          http://geany.svn.sourceforge.net/geany/?rev=4018&view=rev
Author:   ntrel
Date:     2009-07-23 17:30:50 +0000 (Thu, 23 Jul 2009)

Log Message:
-----------
Add dox note for documents_array about using documents_foreach() macro.

Modified Paths:
--------------
    trunk/src/document.c

Modified: trunk/src/document.c
===================================================================
--- trunk/src/document.c	2009-07-23 17:11:31 UTC (rev 4017)
+++ trunk/src/document.c	2009-07-23 17:30:50 UTC (rev 4018)
@@ -89,7 +89,8 @@
  * check @c doc_ptr->is_valid. Of course, the pointer may represent a different
  * file by then.
  *
- * You also need to check @c GeanyDocument::is_valid when iterating over this array.
+ * You also need to check @c GeanyDocument::is_valid when iterating over this array,
+ * although usually you would just use the documents_foreach() macro.
  *
  * Never assume that the order of document pointers is the same as the order of notebook tabs.
  * Notebook tabs can be reordered. Use @c document_get_from_page(). */


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.