"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "Doc/Doc.pm" between
PDL-2.076.tar.gz and PDL-2.077.tar.gz

About: PDL (Perl Data Language) aims to turn perl into an efficient numerical language for scientific computing (similar to IDL and MatLab).

Doc.pm  (PDL-2.076):Doc.pm  (PDL-2.077)
skipping to change at line 185 skipping to change at line 185
automatically indexed when PDL is built and installed, and there is automatically indexed when PDL is built and installed, and there is
provision for indexing external modules as well. provision for indexing external modules as well.
To include your module's pod into the Perl::Doc index, you should To include your module's pod into the Perl::Doc index, you should
follow the documentation conventions below. follow the documentation conventions below.
=head1 PDL documentation conventions =head1 PDL documentation conventions
For a package like PDL that has I<a lot> of functions it For a package like PDL that has I<a lot> of functions it
is very desirable to have some form of online help to is very desirable to have some form of online help to
make it easy for the user to remind himself of names, make it easy for users to remind themselves of names,
calling conventions and typical usage of the multitude calling conventions and typical usage of the multitude
of functions at his disposal. To make it straightforward of functions at their disposal. To make it straightforward
to extract the relevant information from the POD documentation to extract the relevant information from the POD documentation
in source files that make up the PDL distribution in source files that make up the PDL distribution
certain conventions have been adopted in formatting this certain conventions have been adopted in formatting this
documentation. documentation.
The first convention says that all documentation for The first convention says that all documentation for
PDL functions appears in the POD section introduced PDL functions appears in the POD section introduced
by one of the following: by one of the following:
=head1 FUNCTIONS =head1 FUNCTIONS
skipping to change at line 356 skipping to change at line 356
e.g., e.g.,
($x,$y) = rcols 'file1' ($x,$y) = rcols 'file1'
($x,$y,$z) = rcols 'file2', "/foo/",3,4 ($x,$y,$z) = rcols 'file2', "/foo/",3,4
$x = PDL->rcols 'file1'; $x = PDL->rcols 'file1';
Note: currently quotes are required on the pattern. Note: currently quotes are required on the pattern.
It should be clear from the preceding example that readable output It should be clear from the preceding example that readable output
can be obtained from this format using the standard converters and can be obtained from this format using the standard converters and
the reader will hopefully get a feeling how he can easily intersperse the reader will hopefully get a feeling how they can easily intersperse
the special C<=for> directives with the normal POD documentation. the special C<=for> directives with the normal POD documentation.
=head2 Which directives should be contained in the documentation =head2 Which directives should be contained in the documentation
The module documentation should The module documentation should
start with the start with the
=head1 NAME =head1 NAME
PDL::Modulename -- do something with ndarrays PDL::Modulename -- do something with ndarrays
skipping to change at line 767 skipping to change at line 767
$ntot += $n; $ntot += $n;
} }
}; };
File::Find::find($sub,$dir); File::Find::find($sub,$dir);
print "\n\nfound $ntot functions\n"; print "\n\nfound $ntot functions\n";
} }
=head2 funcdocs =head2 funcdocs
extract the complete documentation about a function from its extract the complete documentation about a function from its
source file using the PDL::Pod::Parser filter. source file using the PDL::PodParser filter.
=cut =cut
sub funcdocs { sub funcdocs {
my ($this,$func,$module,$fout) = @_; my ($this,$func,$module,$fout) = @_;
my $hash = $this->ensuredb; my $hash = $this->ensuredb;
barf "unknown function '$func'" unless defined($hash->{$func}); barf "unknown function '$func'" unless defined($hash->{$func});
barf "funcdocs now requires 3 arguments" if defined fileno $module; barf "funcdocs now requires 3 arguments" if defined fileno $module;
my $file = $hash->{$func}->{$module}->{File}; my $file = $hash->{$func}->{$module}->{File};
my $dbf = $hash->{$func}->{$module}->{Dbfile}; my $dbf = $hash->{$func}->{$module}->{Dbfile};
 End of changes. 4 change blocks. 
4 lines changed or deleted 4 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)