C
coltrane
I am just learning javascript and I downloaded a js file from the jsan site.
Throughout the code there are lines that start with "=". What do these
lines mean. Also it seems that descriptive text is added without comment
delimiters. Can this be done?
this is taken from the file:
=head1 DESCRIPTION
This library provides tools to take a filepath and pull the directory
name and
filename out of it. This is much like the perl module 'File::Basename'
or the unix
shell tools of 'basename' and 'dirname'.
This type of tool can be useful if you need to process full paths on the
server in
request but want to display only filenames to the user.
=head2 Constructor
var file = new File.Basename(path, platform);
Create a new C<File.Basename> object.
=over
=item * path
File path to process
=item * platform I<optional>
A 'File.Basename' platform constant, this tells the object how to
process the filepath
it was given. If this is not passed the object will try to guess based
upon the
user agent string. If this is not available then it will default to UNIX.
For the platform constants see the section L<Constants> below.
=back
=head2 Class Properties
=head3 VERSION
File.Basename.VERSION
Current library version
=head2 Methods
=head3 basename()
file.basename();
Throughout the code there are lines that start with "=". What do these
lines mean. Also it seems that descriptive text is added without comment
delimiters. Can this be done?
this is taken from the file:
=head1 DESCRIPTION
This library provides tools to take a filepath and pull the directory
name and
filename out of it. This is much like the perl module 'File::Basename'
or the unix
shell tools of 'basename' and 'dirname'.
This type of tool can be useful if you need to process full paths on the
server in
request but want to display only filenames to the user.
=head2 Constructor
var file = new File.Basename(path, platform);
Create a new C<File.Basename> object.
=over
=item * path
File path to process
=item * platform I<optional>
A 'File.Basename' platform constant, this tells the object how to
process the filepath
it was given. If this is not passed the object will try to guess based
upon the
user agent string. If this is not available then it will default to UNIX.
For the platform constants see the section L<Constants> below.
=back
=head2 Class Properties
=head3 VERSION
File.Basename.VERSION
Current library version
=head2 Methods
=head3 basename()
file.basename();