This "rdoc-f95" package disables original "rdoc"
package because "rdoc-f95" moves files of "rdoc" to
diverted location. If you want to use original "rdoc" package,
please remove "rdoc-f95". Then files of original "rdoc"
package will be returned to proper location.

Following suggested packages enable you to use "diagram" and
"mathml" options (see below).

% apt-get install graphviz libmathml-ruby

Usage

Set the environment variable PATH to include the directory where the
execution program is installed, and RUBYLIB to include the directory
where the libraries are installed.

Move to a directory where your Fortran 90/95 files exist, and execute the
following command. HTML documents will be generated in doc
directory.

Just as in the original RDoc, files
ending with .rb and .rbw are parsed as Ruby programs and
files ending with .c, .cc, .cpp, .CC,
.cxx are parsed as C programs.

With the option —op, the directory where HTML documents are
generated can be changed. —title option sets title of HTML
documents. When —all option is used, private subroutines,
functions etc. in Fortran 90/95 programs are shown in HTML documents (for
developers). If files or directories are specified as arguments (for
example, "src/*.f90" or "test/"), the
particular files are parsed. In the following example, files with suffix
".f90" in a directory "src/" and
files in a directory "test/" are parsed.

Differences to the original one are given below. Note that some differences
were lost because this patch (2005/12/17 version) has been already included
into the original RDoc package.

Addition of —ignore-case option :

In the Fortran 90/95 Standard, upper case letters are not distinguished
from lower case letters, although original RDoc produces case-dependently
cross-references of Class and Methods. When this options is specified,
upper cases are not distinguished from lower cases.

Cross-reference of file names :

Cross-reference of file names is available as well as modules, subroutines,
and so on.

Modification of —style option :

Original RDoc can not treat relative
path stylesheet. Application of this patch modifies this function.

*** Caution *** Documents generated with "—mathml"
option are not displayed correctly according to browser and/or its setting.
We have been confirmed that documents generated with
"—mathml" option are displayed correctly with Mozilla
Firefox and Internet Explorer (+ MathPlayer). See MathML Software - Browsers for other browsers.

Some formats of comments in HTML document are changed to improve the
analysis features. See parsers/parse_f95.rb for details.

Remarks on usage

The enhanced version of the RDoc Fortran
90/95 parser has been constructed on the premise of educational and
academic usages only. For these uses, usage and modification of the
resources withiout notification to the authors is permitted. Licence of the
enhanced version of RDoc Fortran 90/95
parser conforms to that of original RDoc. See README of original RDoc .

When you publish your scientific/technological works using the enhanced
version of RDoc Fortran 90/95 parser, we
will be very glad if you cite our resources in the following way: