Merge topic 'doc-get_filename_component'
df71f96
get_filename_component: Document path components more clearly (#14091)
This commit is contained in:
commit
52b758b5c2
|
@ -62,15 +62,16 @@ public:
|
||||||
virtual const char* GetFullDocumentation() const
|
virtual const char* GetFullDocumentation() const
|
||||||
{
|
{
|
||||||
return
|
return
|
||||||
" get_filename_component(<VAR> FileName\n"
|
" get_filename_component(<VAR> <FileName> <COMP> [CACHE])\n"
|
||||||
" PATH|ABSOLUTE|NAME|EXT|NAME_WE|REALPATH\n"
|
"Set <VAR> to a component of <FileName>, where <COMP> is one of:\n"
|
||||||
" [CACHE])\n"
|
" PATH = Directory without file name\n"
|
||||||
"Set <VAR> to be the path (PATH), file name (NAME), file "
|
" NAME = File name without directory\n"
|
||||||
"extension (EXT), file name without extension (NAME_WE) of FileName, "
|
" EXT = File name longest extension (.b.c from d/a.b.c)\n"
|
||||||
"the full path (ABSOLUTE), or the full path with all symlinks "
|
" NAME_WE = File name without directory or longest extension\n"
|
||||||
"resolved (REALPATH). "
|
" ABSOLUTE = Full path to file\n"
|
||||||
"Note that the path is converted to Unix slashes format and has no "
|
" REALPATH = Full path to existing file with symlinks resolved\n"
|
||||||
"trailing slashes. The longest file extension is always considered. "
|
"Paths are returned with forward slashes and have no trailing slahes. "
|
||||||
|
"The longest file extension is always considered. "
|
||||||
"If the optional CACHE argument is specified, the result variable is "
|
"If the optional CACHE argument is specified, the result variable is "
|
||||||
"added to the cache.\n"
|
"added to the cache.\n"
|
||||||
" get_filename_component(<VAR> FileName\n"
|
" get_filename_component(<VAR> FileName\n"
|
||||||
|
|
Loading…
Reference in New Issue