5. Documentation and Software Conventions
Society for Industrial and Applied Mathematics eBooks · 1999
5.1 Design and Documentation of Argument Lists The argument lists of all LAPACK routines conform to a single set of conventions for their design and documentation. Specifications of all LAPACK driver and computational routines are given in Part 2. These are derived from the specifications given in the leading comments in the code, but in Part 2 the specifications for real and complex versions of each routine have been merged, in order to save space. 5.1.1 Structure of the Documentation The documentation of each LAPACK routine includes: • the SUBROUTINE or FUNCTION statement, followed by statements declaring the type and dimensions of the arguments; • a summary of the Purpose of the routine; • descriptions of each of the Arguments in the order of the argument list; • (optionally) Further Details (only in the code, not in Part 2); • (optionally) Internal Parameters (only in the code, not in Part 2).