[brlcad-commits] SF.net SVN: brlcad:[44048] brlcad/trunk/include/bu.h
Open Source Solid Modeling CAD
Brought to you by:
brlcad
From: <br...@us...> - 2011-03-30 02:30:22
|
Revision: 44048 http://brlcad.svn.sourceforge.net/brlcad/?rev=44048&view=rev Author: brlcad Date: 2011-03-30 02:30:15 +0000 (Wed, 30 Mar 2011) Log Message: ----------- document the behavior on empty strings Modified Paths: -------------- brlcad/trunk/include/bu.h Modified: brlcad/trunk/include/bu.h =================================================================== --- brlcad/trunk/include/bu.h 2011-03-30 02:26:15 UTC (rev 44047) +++ brlcad/trunk/include/bu.h 2011-03-30 02:30:15 UTC (rev 44048) @@ -2482,9 +2482,13 @@ */ /** - * B U _ F I L E _ E X I S T S + * b u _ f i l e _ e x i s t s * - * @return 1 The given filename exists. + * Returns truthfully whether the given file path exists or not. An + * empty or NULL path name is treated as a non-existent file and, as + * such, will return false. + * + * @return >0 The given filename exists. * @return 0 The given filename does not exist. */ BU_EXPORT BU_EXTERN(int bu_file_exists, (const char *path)); @@ -2492,9 +2496,10 @@ /** * b u _ s a m e _ f i l e * - * returns truthfully as to whether or not the two provided filenames - * are the same file. if either file does not exist, the result is - * false. + * Returns truthfully as to whether the two provided filenames are the + * same file. If either file does not exist, the result is false. If + * either filename is empty or NULL, it is treated as non-existent + * and, as such, will also return false. */ BU_EXPORT BU_EXTERN(int bu_same_file, (const char *fn1, const char *fn2)); This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |