This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NAME = "My Project" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This name is used in the # title of most generated pages and in a few other places. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. See # for the list of possible encodings. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. #- # Project related configuration options #- # This tag specifies the encoding used for all characters in the config file # that follow. # The format is: # TAG = value # For lists, items can also be appended using: # TAG += value # Values that contain spaces should be placed between quotes (\" \"). # All text after a single hash (#) is considered a comment and will be ignored. # All text after a double hash (#) is considered a comment and is placed in # front of the TAG it is preceding. doc/index.html in your # Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (for a project. The project file named project.md and the source code path Run the FORD compiler inside your project directory: $ ford project.md -d. Now is the time for all good men to come to the aid of the party.įor further details. You can add a description in Markdown here. This documentation has been generated with (). Summary: A brief description of my project.Īuthor_description: I program things in Fortran. Project.md in your workspace directory, containing: project: Super Cool Fortran Project Without creating a virtual environment first: $ python3 -m pip install -user fordįORD requires a project description in Markdown format. Or, instead, just install FORD into the Python user install directory, $ source virtual-environment/bin/activate Venv and pip: $ python3 -m venv virtual-environment/ The tool can be installed into a virtual environment using SphinxFortran (CeCILL) Fortan 90 extension for the Python documentation generator Sphinx.ĭepends on the Python packages sphinx and To HTML, LaTeX, ASCII, XML DocBook, or RTF. For each block ( function,įormatted header must be written. ROBOdoc (GNU GPL v3) ROBOdoc is a documentation tool for various programming languages, It also features a graphical user interface. FortranDOC (GNU GPL v3) A Fortran 95 program for source code documentation, with LaTeX output. Offers LaTeX support, online search, syntax FORD (GNU GPL v3) An automatic documentation generator for modern Fortran (> 90), f90tohtml (MIT) A Perl script that converts Fortran 90 source code to HTML and creates aĬlickable calling tree. f90doc (MIT) A simple documentation tool for Fortran 90 that outputs HTML pages. Graph generation, man page generation, as well as output to LaTeX and Several tools for automatic source code documentation are availableįor Fortran projects: Doxygen (GNU GPL v2) A popular documentation generator that supports several programming The documentation of source code is an important part of modern softwareĭevelopment.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |