improve documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@32840 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2011-04-13 14:30:20 +00:00
parent b1745e7d9d
commit 310d405479

View file

@ -1544,7 +1544,11 @@ NSHomeDirectory(void)
}
/**
* Returns loginName's home directory as an NSString object.
* Returns loginName's home directory as an NSString object.<br />
* On most systems this returns the directory specified in the system's
* password file, but on ms-windows this is determined by examining the
* HOMEPATH and HOMEDRIVE environment variables or (if those don't make
* sense) the USERPROFILE environment variable.
*/
/* NOTE FOR DEVELOPERS.
* If you change the behavior of this method you must also change