fix some errors in comments causing documentation generation problems

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

ChangeLog

@@ -1,3 +1,13 @@
+2009-04-26 Richard Frith-Macdonald <rfm@gnu.org>
+
+	* Headers/Foundation/NSTimeZone.h:
+	* Headers/Foundation/NSPropertyList.h:
+	* Headers/Foundation/NSZone.h:
+	* Source/NSHashTable.m:
+	* Source/NSZone.m:
+	* Source/NSDecimal.m:
+	Fix errors generating documentation.
+
 2009-04-26 Richard Frith-Macdonald <rfm@gnu.org>
 
 	* Source/NSFileManager.m: ([changeFileAttributes:atPath:]) optimise

Headers/Foundation/NSPropertyList.h

@@ -47,12 +47,12 @@ enum {
 /**
  * Describes the mutability to use when generating objects during
  * deserialisation of a property list.
- * <example>
- * <strong>NSPropertyListImmutable</strong>
- * all objects in created list are immutable
- * <strong>NSPropertyListMutableContainers</strong>
- * dictionaries, arrays, strings and data objects are mutable
- * </example>
+ * <list>
+ * <item><strong>NSPropertyListImmutable</strong>
+ * all objects in created list are immutable</item>
+ * <item><strong>NSPropertyListMutableContainers</strong>
+ * dictionaries, arrays, strings and data objects are mutable</item>
+ * </list>
  */
 typedef NSUInteger NSPropertyListMutabilityOptions;
 
@@ -66,18 +66,18 @@ enum {
 };
 /**
  * Specifies the serialisation format for a serialised property list.
- * <example>
- * <strong>NSPropertyListOpenStepFormat</strong>
- * the most human-readable format
- * <strong>NSPropertyListXMLFormat_v1_0</strong>
- * portable and readable
- * <strong>NSPropertyListBinaryFormat_v1_0</strong>
- * the standard format on macos-x
- * <strong>NSPropertyListGNUstepFormat</strong>
- * extension of OpenStep format
- * <strong>NSPropertyListGNUstepBinaryFormat</strong>
- * efficient, hardware independent
- * </example>
+ * <list>
+ * <item><strong>NSPropertyListOpenStepFormat</strong>
+ * the most human-readable format</item>
+ * <item><strong>NSPropertyListXMLFormat_v1_0</strong>
+ * portable and readable</item>
+ * <item><strong>NSPropertyListBinaryFormat_v1_0</strong>
+ * the standard format on macos-x</item>
+ * <item><strong>NSPropertyListGNUstepFormat</strong>
+ * extension of OpenStep format</item>
+ * <item><strong>NSPropertyListGNUstepBinaryFormat</strong>
+ * efficient, hardware independent</item>
+ * </list>
  */
 typedef NSUInteger NSPropertyListFormat;
 

Headers/Foundation/NSTimeZone.h

@@ -35,6 +35,16 @@ extern "C" {
 @class  NSLocale;
 @class	NSString;
 
+#if OS_API_VERSION(100500,GS_API_LATEST) 
+enum {
+  NSTimeZoneNameStyleStandard,
+  NSTimeZoneNameStyleShortStandard,
+  NSTimeZoneNameStyleDaylightSaving,
+  NSTimeZoneNameStyleShortDaylightSaving
+};
+typedef NSInteger NSTimeZoneNameStyle;
+#endif
+
 @interface NSTimeZone : NSObject
 
 //Creating and Initializing an NSTimeZone
@@ -86,13 +96,6 @@ extern "C" {
 /** Not implemented */
 - (NSDate *) nextDaylightSavingTimeTransition;
 
-enum {
-  NSTimeZoneNameStyleStandard,
-  NSTimeZoneNameStyleShortStandard,
-  NSTimeZoneNameStyleDaylightSaving,
-  NSTimeZoneNameStyleShortDaylightSaving
-};
-typedef NSInteger NSTimeZoneNameStyle;
 - (NSString *)localizedName: (NSTimeZoneNameStyle)style
                      locale: (NSLocale *)locale;
 GS_EXPORT NSString * const NSSystemTimeZoneDidChangeNotification;

Headers/Foundation/NSZone.h

@@ -112,7 +112,7 @@ NSZoneFromPointer (void *ptr);
  * given zone.  Returns NULL if allocation of size 0 requested.  Raises
  * <code>NSMallocException</code> if not enough free memory in zone to
  * allocate and no more can be obtained from system, unless using the
- * default zone, in which case NULL is returned.<br \>
+ * default zone, in which case NULL is returned.<br />
  * If Garbage Collection is enabled, this function always allocates
  * non-scanned, non-collectable memory in the NSDefaultMallocZone() and
  * the zone argument is ignored.

Source/NSDecimal.m

@@ -1120,7 +1120,7 @@ NSSimpleCompare(const NSDecimal *leftOperand, const NSDecimal *rightOperand)
 }
 
 void
-NSDecimalRound(NSDecimal *result, const NSDecimal *number, int scale,
+NSDecimalRound(NSDecimal *result, const NSDecimal *number, NSInteger scale,
 	       NSRoundingMode mode)
 {
   GSDecimal m;

Source/NSHashTable.m

@@ -72,7 +72,7 @@ static Class	concreteClass = 0;
   return AUTORELEASE(t);
 }
 
-+ (id) hashTableWithWeakObjects;
++ (id) hashTableWithWeakObjects
 {
   return [self hashTableWithOptions:
     NSPointerFunctionsObjectPersonality | NSPointerFunctionsZeroingWeakMemory];
@@ -276,7 +276,7 @@ static Class	concreteClass = 0;
     }
 }
 
-- (void) removeObject: (id)aKey
+- (void) removeObject: (id)object
 {
   [self subclassResponsibility: _cmd];
 }

Source/NSZone.m

@@ -372,9 +372,9 @@ NSZoneStats NSZoneStats (NSZone *zone)
 }
 
 void
-GSMakeWeakPointer(Class class, const char *iVarName)
+GSMakeWeakPointer(Class theClass, const char *iVarName)
 {
-  class_ivar_set_gcinvisible(class, iVarName, YES);
+  class_ivar_set_gcinvisible(theClass, iVarName, YES);
 }
 
 BOOL
@@ -1992,7 +1992,7 @@ GSAtomicMallocZone (void)
 }
 
 void
-GSMakeWeakPointer(Class class, const char *iVarName)
+GSMakeWeakPointer(Class theClass, const char *iVarName)
 {
   return;
 }