From 90fb54104deb545dd8049d1e60d09bc989193604 Mon Sep 17 00:00:00 2001 From: kirkpatc Date: Thu, 29 May 2008 07:55:13 +0000 Subject: [PATCH] FPDoc - more methods defined in FileUtil.xml git-svn-id: trunk@15273 - --- docs/xml/lcl/fileutil.xml | 171 ++++++++++++++++++++++---------------- 1 file changed, 98 insertions(+), 73 deletions(-) diff --git a/docs/xml/lcl/fileutil.xml b/docs/xml/lcl/fileutil.xml index 37b94c31c4..8013958515 100644 --- a/docs/xml/lcl/fileutil.xml +++ b/docs/xml/lcl/fileutil.xml @@ -71,48 +71,58 @@ - - - - + Checks whether an absolute file name is given in TheFileName + + +

Checks whether an absolute file name is given in TheFileName +

+

Makes use of FilenameIsWinAbsolute on Windows systems, otherwise uses FilenameIsUnixAbsolute +

+ - + Returns True if an absolute filename has been supplied - + The name of the file to be checked - - - - + + FilenameIsWinAbsolute - checks that the supplied name is an absolute file name for the Windows system + +

+ FilenameIsWinAbsolute - checks that the supplied name is an absolute file name for the Windows system

+

Looks, for instance, for Drive Letters and colon at the beginning of the string

+ - + Returns True if this is a true absolite Windows filename - + The name of the file for checking - - - - + + FilenameIsUnixAbsolute - checks that the supplied name is an absolute filename in Unix systems + +

+ FilenameIsUnixAbsolute - checks that the supplied name is an absolute filename in Unix systems

+

Checks that the name is non-empty and starts with a slash

+ - + Returns True if the supplied name is a correct Absolute file name for a Unix system - + The name of the file for checking @@ -148,52 +158,62 @@ - - - - + + FileIsReadable - checks whether supplied file name refers to a readable file + +

+ FileIsReadable - checks whether supplied file name refers to a readable file

+

Always true on Windows systems.

+

On Unix systems, checks permissions of file

+ - + Always true in Windows; in Unix systems, returns true if read permission exists for the file - + Name of the file for checking - - - - + + FileIsWritable - checks if the supplied file name refers to a file that is writable + +

+ FileIsWritable - checks if the supplied file name refers to a file that is writable

+

Checks file permissions in both Unix and Windows systems

+ - + Returns True if Write permission exists - + The name of the file for checking - - - - + + FileIsText - checks whether the supplied file name refers to a readale text file + +

+ FileIsText - checks whether the supplied file name refers to a readale text file

+

Searches the opening section of the file for non-text characters such as ASCII 0 to 31 (except CR and LF, the new line characters)

+ - + Returns True if the file is a text file - + The name of the file for checking - + Returns false if non-text characters are detected @@ -212,33 +232,34 @@ - - - - + + FileIsSymLink - check if file name is a symbolic link + +

+ FileIsSymLink - check if file name is a symbolic link

+

On Windows systems, always returns false. On others, returns true if it is a symbolic link

+ - + Returns True if file name is a symbolic link (always false in Windows systems) - + Name of the file for checking - - - - + + FileSize - finds the size of the named file - + Returns the size of the file, or -1 if not there - + The name of the file for checking @@ -276,18 +297,15 @@ - - - - + Checks if the given directory path exists - + Returns True if the given directory path exists - + Name of the directory path to be checked @@ -372,18 +390,16 @@ - - - - + + ExtractFileNameWithoutExt - returns just the name of the file without an extension - + Returns the original file name if it had no extension, otherwise returns the file name with its extension removed - + The name of the file for checking @@ -408,25 +424,30 @@ CaseSensitive - if True, case of + Ext must match case in + FileName - - - - + + FilenameIsPascalUnit - checks that the supplied name is a correct Pascal unit name + +

+ FilenameIsPascalUnit - checks that the supplied name is a correct Pascal unit name

+

Looks at the file extension to see if it matches one of the standard Pascal extensions (currently .p, .pp, .pas)

+ - + Returns True if the supplied name is a correct Pascal Unit filename - + The name of the file for checking @@ -461,18 +482,16 @@ - - - - + + TrimFilename - trim double path delimiters, heading and trailing spaces and special dirs . and .. - + Returns the original file name if no trimming was needed, otherwise returns the trimmed file name - + The name of the file for trimming @@ -508,14 +527,18 @@ CreateAbsoluteSearchPath - concatenates + BaseDirectory and + SearchPath to form an absolute path to search for files

CreateAbsoluteSearchPath - concatenates + BaseDirectory and + SearchPath to form an absolute path to search for files

Adds appropriate path delimiters to the BaseDirectory string, then adds the search path, checking that each directory in the path is in fact an absolutely specified directory, then returns the fully formed absolute search path.

 @@ -544,10 +567,12 @@ CreateRelativePath - given an absolute path and a + BaseDirectory, create a search path relative to the current directory

CreateRelativePath - given an absolute path and a + BaseDirectory, create a search path relative to the current directory

The returned string includes the correct number of dots and double dots to signify relativity to the current directory (eg ../../or ..\..\ etc)