Tidied documentation a little

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

Headers/Foundation/NSFileManager.h

@@ -217,18 +217,27 @@
 - (BOOL) fileExistsAtPath: (NSString*)path isDirectory: (BOOL*)isDirectory;
 - (NSDictionary*) fileSystemAttributesAtPath: (NSString*)path;
 
+#if	defined(__MINGW32__)
 /**
  * Convert from OpenStep internal string format to a string in
  * the local filesystem format, suitable for passing to system functions.<br />
  * This representation may vary between filesystems.<br />
- * On windows, the filesystem representation is 16-bit unicode and is expected
- * to be used in conjunction with the variants of system calls which work
- * with unicode strings.<br />
+ * On mingw32 systems, the filesystem representation is 16-bit unicode and is
+ * expected to be used in conjunction with the variants of system calls which
+ * work with unicode strings.<br />
  * Raises an exception if the character conversion is not possible.
  */
-#if	defined(__MINGW32__)
 - (const unichar*) fileSystemRepresentationWithPath: (NSString*)path;
 #else
+/**
+ * Convert from OpenStep internal string format to a string in
+ * the local filesystem format, suitable for passing to system functions.<br />
+ * This representation may vary between filesystems.<br />
+ * On mingw32 systems, the filesystem representation is 16-bit unicode and is
+ * expected to be used in conjunction with the variants of system calls which
+ * work with unicode strings.<br />
+ * Raises an exception if the character conversion is not possible.
+ */
 - (const char*) fileSystemRepresentationWithPath: (NSString*)path;
 #endif
 
@@ -246,18 +255,26 @@
 - (BOOL) removeFileAtPath: (NSString*)path
 		  handler: (id)handler;
 
+#if	defined(__MINGW32__)
 /**
  * Convert to OpenStep internal string format from a string in
  * the local filesystem format, as returned by system functions.<br />
  * This representation may vary between filesystems.<br />
- * On windows, the filesystem representation is 16-bit unicode and is expected
- * to have come from the variant of a system call which works
+ * On mingw32 systems, the filesystem representation is 16-bit unicode and
+ * is expected to have come from the variant of a system call which works
  * with unicode strings.
  */
-#if	defined(__MINGW32__)
 - (NSString*) stringWithFileSystemRepresentation: (const unichar*)string
 					  length: (unsigned int)len;
 #else
+/**
+ * Convert to OpenStep internal string format from a string in
+ * the local filesystem format, as returned by system functions.<br />
+ * This representation may vary between filesystems.<br />
+ * On mingw32 systems, the filesystem representation is 16-bit unicode and
+ * is expected to have come from the variant of a system call which works
+ * with unicode strings.
+ */
 - (NSString*) stringWithFileSystemRepresentation: (const char*)string
 					  length: (unsigned int)len;
 #endif

Headers/Foundation/NSString.h

@@ -333,33 +333,50 @@ enum {
 		       matchesIntoArray: (NSArray**)outputArray
 			    filterTypes: (NSArray*)filterTypes;
 
+#if	defined(__MINGW32__)
 /**
  * Converts the receiver to a C string path expressed in the character
  * encoding appropriate for the local host file system.  This string will be
  * automatically freed soon after it is returned, so copy it if you need it
  * for long.<br />
- * NB. On ms-windows the filesystem representation of a path is a 16-bit
+ * NB. On mingw32 systems the filesystem representation of a path is a 16-bit
  * unicode character string, so you should only pass the value returned by
  * this method to functions expecting wide characters.
  */
-#if	defined(__MINGW32__)
 - (const unichar*) fileSystemRepresentation;
 #else
+/**
+ * Converts the receiver to a C string path expressed in the character
+ * encoding appropriate for the local host file system.  This string will be
+ * automatically freed soon after it is returned, so copy it if you need it
+ * for long.<br />
+ * NB. On mingw32 systems the filesystem representation of a path is a 16-bit
+ * unicode character string, so you should only pass the value returned by
+ * this method to functions expecting wide characters.
+ */
 - (const char*) fileSystemRepresentation;
 #endif
 
+#if	defined(__MINGW32__)
 /**
  * Converts the receiver to a C string path using the character encoding
  * appropriate to the local file system.  This string will be stored
  * into buffer if it is shorter than size, otherwise NO is returned.<br />
- * NB. On ms-windows the filesystem representation of a path is a 16-bit
+ * NB. On mingw32 systems the filesystem representation of a path is a 16-bit
  * unicode character string, so the buffer you pass to this method must be
  * twice as many bytes as the size (number of characters) you expect to receive.
  */
-#if	defined(__MINGW32__)
 - (BOOL) getFileSystemRepresentation: (unichar*)buffer
 			   maxLength: (unsigned int)size;
 #else
+/**
+ * Converts the receiver to a C string path using the character encoding
+ * appropriate to the local file system.  This string will be stored
+ * into buffer if it is shorter than size, otherwise NO is returned.<br />
+ * NB. On mingw32 systems the filesystem representation of a path is a 16-bit
+ * unicode character string, so the buffer you pass to this method must be
+ * twice as many bytes as the size (number of characters) you expect to receive.
+ */
 - (BOOL) getFileSystemRepresentation: (char*)buffer
 			   maxLength: (unsigned int)size;
 #endif