Tidied documentation a little

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@21953 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2005-11-05 07:00:49 +00:00
parent 649fb4ffc9
commit ffb1c7466d
2 changed files with 45 additions and 11 deletions

View file

@ -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