RDocF95: Enhanced version of RDoc Fortran 90/95 parser
-
Project Page: rubyforge.org/projects/rdoc/
-
Documentation: rdoc-f95.rubyforge.org/
DESCRIPTION:
RDocF95 is an improved RDoc for generation of documents of Fortran 90/95 programs.
Differences to the original one are given below.
- Enhancement of “parser/f95.rb”
-
The Fortran 90/95 parse script “parser/f95.rb” (In rdoc-f95, old name “parsers/parse_f95.rb” is used yet) is modified in order to parse almost all entities of the Fortran 90/95 Standard.
- 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.
- Conversion of TeX formula into MathML
-
TeX formula can be converted into MathML format with –mathml option, if MathML library for Ruby version 0.6b – 0.8 is installed. This library is available from Bottega of Hiraku (only JAPANESE). See RDocF95::Markup::ToXHtmlTexParser about format.
*** 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 parse_f95.rb
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.
% rdoc-f95 -U --ignore-case --inline-source
Files ending .f90
, .F90
, .f95
, .F95
are parsed as Fortran 90/95 programs. All Fortran 90/95 programs in subdirectories are parsed recursively.
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.
% rdoc-f95 -U --ignore-case --inline-source \
--op rdoc --title "RDoc documentations" src/*.f90 test/
Alternatively, you can parse only a part of files by creating a “.document
” file and writing names of the files and the directories to the file.
For more information, see www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html
TEMPLATE NOTE:
Refer to parse_f95.rb which explains parsed information, way of looking at documents, the format of comment blocks in Fortran 90/95 source code. If you use “–mathml” option (see below), refer to RDocF95::Markup::ToXHtmlTexParser, too. For general information, see www.ruby-doc.org/stdlib/libdoc/rdoc/rdoc/index.html
SAMPLES:
LICENSE:
Licence of RDocF95 conforms to that of original RDoc. see rdoc.rubyforge.org/