Contents

 
• List of Tables
• 1 Introduction
• 2 Rationale for an Automated Documentation System
  • 2.1 LAPACK
    • Example:
  • 2.2 LAPACK90
    • Example:
  • 2.3 PPGP
    • Example:
  • 2.4 Epilogue: Lessons for the Future
• 3 Goals and Assumptions
• 4 Available Public Domain Software
  • 4.1 FWEB
    • Example:
  • 4.2 SRC2TEX
    • Example:
  • 4.3 DOCFOR
• 5 Suggested Solution
  • 5.1 Concept
  • 5.2 Usage
  • 5.3 Possible Extensions
• References
• APPENDIX: Reference Manual for ProTeX
  • A.1 Documenting Conventions
    • Introduction Keywords:
    • Prologue Keywords:
    • Example 1: ATESS Routine
    • Example 2: DGESV_F90 revisited
  • Tools: LaTeX Generation with ProTeX
    • Mapping of code to a LaTeX document
    • Example: DGESV_F90 LaTeX Output
    • DGESV_F90() -- Fortran90 wrapper to LAPACK DGESV
  • A.3 Tools: automatic generation of documentation
  • A.4 ProTex Templates
    • A.4.1 Template for routines which are not internal to modules
    • A.4.2 Template for a routine internal to a module
    • A.4.3 Template for a module
    • A.4.4 Template for a Fortran include file
    • A.4.5 Template for an Introduction
• About this document ...