File tree Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Expand file tree Collapse file tree 1 file changed +18
-0
lines changed Original file line number Diff line number Diff line change @@ -67,3 +67,21 @@ focus on the semantics of the proposed changes rather than style and formatting.
67
67
Fortran allows certain block constructs or scopes to include the name of the program unit in the end statement.
68
68
The convention adopted herein is to include procedure names, ` module ` names and ` program ` names in the ` end ` statement,
69
69
unless the closing statement can reasonably be expected to be on the same screen or page, within about 25 lines.
70
+
71
+ ## Document public and protected entities and arguments using FORD
72
+
73
+ Documentation strings should be provided for all public and protected entities and their arguments or parameters.
74
+ This is currently accomplished using the [ FORD tool] ( https://github.com/Fortran-FOSS-Programmers/ford ) .
75
+ For help writing FORD style documentation please see the [ FORD wiki] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki ) .
76
+ The following two sections are most relevant for contributing new code:
77
+
78
+ * [ Writing Documentation] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki/Writing-Documentation )
79
+ * [ Documentation Meta Data] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki/Documentation-Meta-Data )
80
+ * [ Limitations] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki/Limitations )
81
+
82
+ For write the "spec" (specification) for a new proposal, please place it in the
83
+ [ FORD "pages"] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki/Writing-Pages ) directory at
84
+ [ ` doc/specs/ ` ] ( https://github.com/fortran-lang/stdlib/tree/master/doc/specs ) .
85
+ To get help please see the [ "Writing Pages"] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki/Writing-Pages )
86
+ and [ "Writing Documentation"] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki/Writing-Documentation ) pages
87
+ on the [ FORD wiki] ( https://github.com/Fortran-FOSS-Programmers/ford/wiki ) .
You can’t perform that action at this time.
0 commit comments