Difference between revisions of "GENIE Using NaturalDocs"
Jump to navigation
Jump to search
Line 7: | Line 7: | ||
<pre> | <pre> | ||
MODULE mymodule | MODULE mymodule | ||
− | |||
! File: mymodule.f90 | ! File: mymodule.f90 | ||
! | ! | ||
Line 13: | Line 12: | ||
! | ! | ||
! A module containing some pretty useful stuff for use with widgets. | ! A module containing some pretty useful stuff for use with widgets. | ||
− | |||
− | |||
! var: koverall | ! var: koverall | ||
! An important variable that I would like to document. | ! An important variable that I would like to document. | ||
− | |||
− | integer :: koverall | + | integer :: koverall |
− | |||
! Subroutine: Multiply | ! Subroutine: Multiply | ||
! | ! | ||
Line 37: | Line 32: | ||
! | ! | ||
! z - The result. | ! z - The result. | ||
− | |||
subroutine Multiply (x, y, z) | subroutine Multiply (x, y, z) | ||
Line 48: | Line 42: | ||
end subroutine | end subroutine | ||
− | |||
end MODULE | end MODULE | ||
</pre> | </pre> |
Revision as of 16:07, 4 April 2007
Intro
Quickstart
Here is a quick and simple example showing how you immediately get going using NaturalDocs:
MODULE mymodule ! File: mymodule.f90 ! ! Description: ! ! A module containing some pretty useful stuff for use with widgets. ! var: koverall ! An important variable that I would like to document. integer :: koverall ! Subroutine: Multiply ! ! Multiplies two integers. ! ! Input: ! ! x - The first integer. ! y - The second integer. ! ! Input/Output: ! ! Output: ! ! z - The result. subroutine Multiply (x, y, z) integer, intent(in) :: x integer, intent(in) :: y integer, intent(out) :: z z = x * y end subroutine end MODULE