mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Improved some documentation in the File class.

Browse source
This commit is contained in:
jules 2013-07-08 17:59:37 +01:00
parent 13304ac410
commit 23f59fd99c
1 changed files with 17 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

32
modules/juce_core/files/juce_File.h
View file

@ -75,10 +75,10 @@ public:
On the Mac/Linux, the path can include "~" notation for referring to
user home directories.
*/
File (const String& path);
File (const String& absolutePath);
/** Creates a copy of another file object. */
File (const File& other);
File (const File&);
/** Destructor. */
~File() noexcept {}
@ -93,14 +93,14 @@ public:
On the Mac/Linux, the path can include "~" notation for referring to
user home directories.
*/
File& operator= (const String& newFilePath);
File& operator= (const String& newAbsolutePath);
/** Copies from another file object. */
File& operator= (const File& otherFile);
#if JUCE_COMPILER_SUPPORTS_MOVE_SEMANTICS
File (File&& otherFile) noexcept;
File& operator= (File&& otherFile) noexcept;
File (File&&) noexcept;
File& operator= (File&&) noexcept;
#endif
//==============================================================================
@ -250,12 +250,13 @@ public:
int64 hashCode64() const;
//==============================================================================
/** Returns a file based on a relative path.
/** Returns a file that represents a relative (or absolute) sub-path of the current one.
This will find a child file or directory of the current object.
e.g.
File ("/moose/fish").getChildFile ("foo.txt") will produce "/moose/fish/foo.txt".
File ("/moose/fish").getChildFile ("haddock/foo.txt") will produce "/moose/fish/haddock/foo.txt".
File ("/moose/fish").getChildFile ("../foo.txt") will produce "/moose/foo.txt".
If the string is actually an absolute path, it will be treated as such, e.g.
@ -263,7 +264,7 @@ public:
@see getSiblingFile, getParentDirectory, getRelativePathFrom, isAChildOf
*/
File getChildFile (String relativePath) const;
File getChildFile (String relativeOrAbsolutePath) const;
/** Returns a file which is in the same directory as this one.
@ -326,13 +327,13 @@ public:
//==============================================================================
/** Compares the pathnames for two files. */
bool operator== (const File& otherFile) const;
bool operator== (const File&) const;
/** Compares the pathnames for two files. */
bool operator!= (const File& otherFile) const;
bool operator!= (const File&) const;
/** Compares the pathnames for two files. */
bool operator< (const File& otherFile) const;
bool operator< (const File&) const;
/** Compares the pathnames for two files. */
bool operator> (const File& otherFile) const;
bool operator> (const File&) const;
//==============================================================================
/** Checks whether a file can be created or written to.
@ -883,19 +884,20 @@ public:
static const String separatorString;
//==============================================================================
/** Removes illegal characters from a filename.
/** Returns a version of a filename with any illegal characters removed.
This will return a copy of the given string after removing characters
that are not allowed in a legal filename, and possibly shortening the
string if it's too long.
Because this will remove slashes, don't use it on an absolute pathname.
Because this will remove slashes, don't use it on an absolute pathname - use
createLegalPathName() for that.
@see createLegalPathName
*/
static String createLegalFileName (const String& fileNameToFix);
/** Removes illegal characters from a pathname.
/** Returns a version of a path with any illegal characters removed.
Similar to createLegalFileName(), but this won't remove slashes, so can
be used on a complete pathname.
@ -915,7 +917,7 @@ public:
Best to avoid this unless you really know what you're doing.
*/
static File createFileWithoutCheckingPath (const String& path) noexcept;
static File createFileWithoutCheckingPath (const String& absolutePath) noexcept;
/** Adds a separator character to the end of a path if it doesn't already have one. */
static String addTrailingSeparator (const String& path);