Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#78 add support for cross-ref/see-also in pdl function =head2

open
nobody
None
5
2013-09-19
2013-09-19
Chris Marshall
No

The current PDL::Doc standard for documentation marks functions or methods
in =head1 FUNCTIONS, =head2 OPERATORS, =head1 METHODS, or =head1 CONSTRUCTORS
by =head2 funcname where funcname can only be one name. If there is other
"stuff" on the =head2 line, then searching and/or indexing in the PDL docs
database doesn't work.

It would be nice if the function descriptions could include multiple routines
against the same section such as PDL::FFTW3 documentation for the various
versions of fftN (fft1, fft2, fft3,...) since they all do the same thing
except with different numbers of threaded dimensions.

Another example would be the generated documentation for the various
type conversion routines (byte, long, longlong, double, float,...) with
a See also Datatype_Conversions. Of course, the actual documentation
with usage examples are in Datatype_Conversions which never shows
up in "help byte" for example.

Discussion