[Bug 2243337] New: Review Request: ford - Generate FORtran Documentation from code comments

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



https://bugzilla.redhat.com/show_bug.cgi?id=2243337

            Bug ID: 2243337
           Summary: Review Request: ford - Generate FORtran Documentation
                    from code comments
           Product: Fedora
           Version: rawhide
                OS: Linux
            Status: NEW
         Component: Package Review
          Severity: medium
          Assignee: nobody@xxxxxxxxxxxxxxxxx
          Reporter: benson_muite@xxxxxxxxxxxxx
        QA Contact: extras-qa@xxxxxxxxxxxxxxxxx
                CC: package-review@xxxxxxxxxxxxxxxxxxxxxxx
  Target Milestone: ---
    Classification: Fedora



spec:
https://download.copr.fedorainfracloud.org/results/fed500/ford/fedora-rawhide-x86_64/06517293-ford/ford.spec
srpm:
https://download.copr.fedorainfracloud.org/results/fed500/ford/fedora-rawhide-x86_64/06517293-ford/ford-6.2.5-1.fc40.src.rpm

description:
This is an automatic documentation generator for modern Fortran programs.
FORD stands for FORtran Documenter. As you may know, "to ford" refers to
crossing a river (or other body of water). It does not, in this context,
refer to any company or individual associated with cars.

Ford was written due to Doxygen's poor handling of Fortran and the lack of
comparable alternatives. ROBODoc can't actually extract any information from
the source code and just about any other automatic documentation software I
found was either proprietary, didn't work very well for Fortran, or was
limited in terms of how it produced its output. f90doc is quite good and I
managed to modify it so that it could handle most of Fortran 2003, but it
produces rather ugly documentation, can't provide as many links between
different parts of the documentation as I'd like, and is written in Perl
(which I'm not that familiar with and which lacks the sort of libraries
found in Python for producing HTML content).

The goal of FORD is to be able to reliably produce documentation for modern
Fortran software which is informative and nice to look at. The documentation
should be easy to write and non-obtrusive within the code. While it will never
be as feature-rich as Doxygen, hopefully FORD will be able to provide a good
alternative for documenting Fortran projects.

fas: fed500

Reproducible: Always


-- 
You are receiving this mail because:
You are on the CC list for the bug.
You are always notified about changes to this product and component
https://bugzilla.redhat.com/show_bug.cgi?id=2243337

Report this comment as SPAM: https://bugzilla.redhat.com/enter_bug.cgi?product=Bugzilla&format=report-spam&short_desc=Report%20of%20Bug%202243337%23c0
_______________________________________________
package-review mailing list -- package-review@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to package-review-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/package-review@xxxxxxxxxxxxxxxxxxxxxxx
Do not reply to spam, report it: https://pagure.io/fedora-infrastructure/new_issue




[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Yosemite Conditions]     [KDE Users]

  Powered by Linux