HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add dox note for documents_array about using documents_foreach() macro.

Browse Source 
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@4018 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Nick Treleaven 2009-07-23 17:30:50 +00:00
parent 4a61fd4620
commit c27eb4a19f
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/document.c
View File

@ -89,7 +89,8 @@ GeanyFilePrefs file_prefs;
* 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(). */