added GSdoc comments to class, method, and function declarations; for some classes some comments were already in the source file (not the header), in which case further comments were added here; otherwise comments were put in the headers

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@19588 72102866-910b-0410-8b05-ffd578937521

Source/NSEnumerator.m

@@ -29,8 +29,15 @@
 #include "Foundation/NSUtilities.h"
 #include "Foundation/NSArray.h"
 
+/**
+ *  Simple class for iterating over a collection of objects, usually returned
+ *  from an [NSArray] or similar.
+ */
 @implementation NSEnumerator
 
+/**
+ *  Returns all objects remaining in the enumeration as an array.
+ */
 - (NSArray*) allObjects
 {
   NSMutableArray	*array;
@@ -54,6 +61,10 @@
   return array;
 }
 
+/**
+ *  Returns next object in enumeration, or nil if none remain.  Use code like
+ *  <code>while (object = [enumerator nextObject]) { ... }</code>.
+ */
 - (id) nextObject
 {
   [self subclassResponsibility:_cmd];