1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
|
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--Converted with LaTeX2HTML 96.1-h (September 30, 1996) by Nikos Drakos (nikos@cbl.leeds.ac.uk), CBLU, University of Leeds -->
<HTML>
<HEAD>
<TITLE>Structure of the Documentation</TITLE>
<META NAME="description" CONTENT="Structure of the Documentation">
<META NAME="keywords" CONTENT="slug">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<LINK REL=STYLESHEET HREF="slug.css">
</HEAD>
<BODY LANG="EN" >
<A NAME="tex2html3351" HREF="node94.html"><IMG WIDTH=37 HEIGHT=24 ALIGN=BOTTOM ALT="next" SRC="http://www.netlib.org/utk/icons/next_motif.gif"></A> <A NAME="tex2html3349" HREF="node92.html"><IMG WIDTH=26 HEIGHT=24 ALIGN=BOTTOM ALT="up" SRC="http://www.netlib.org/utk/icons/up_motif.gif"></A> <A NAME="tex2html3343" HREF="node92.html"><IMG WIDTH=63 HEIGHT=24 ALIGN=BOTTOM ALT="previous" SRC="http://www.netlib.org/utk/icons/previous_motif.gif"></A> <A NAME="tex2html3353" HREF="node1.html"><IMG WIDTH=65 HEIGHT=24 ALIGN=BOTTOM ALT="contents" SRC="http://www.netlib.org/utk/icons/contents_motif.gif"></A> <A NAME="tex2html3354" HREF="node190.html"><IMG WIDTH=43 HEIGHT=24 ALIGN=BOTTOM ALT="index" SRC="http://www.netlib.org/utk/icons/index_motif.gif"></A> <BR>
<B> Next:</B> <A NAME="tex2html3352" HREF="node94.html">Order of Arguments</A>
<B>Up:</B> <A NAME="tex2html3350" HREF="node92.html">Design and Documentation of </A>
<B> Previous:</B> <A NAME="tex2html3344" HREF="node92.html">Design and Documentation of </A>
<BR> <P>
<H2><A NAME="SECTION04461000000000000000">Structure of the Documentation</A></H2>
<A NAME="subsecstructdoc"> </A>
<P>
The documentation<A NAME="3382"> </A>
of each ScaLAPACK routine includes the following:
<P>
<UL>
<LI> The SUBROUTINE or FUNCTION statement,
followed by statements declaring the type
and dimensions of the arguments.
<LI> A summary of the <B>Purpose</B> of the routine.
<LI> Descriptions of each of the <B>Arguments</B> in
the order of the argument list.
<LI> (optionally) <B>Further Details</B> (only in
the code, not in Part <A HREF="node187.html#partroutines">ii</A> of
this users guide);
<LI> (optionally) <B>Internal Parameters</B> (only
in the code, not in Part <A HREF="node187.html#partroutines">ii</A>
of this users guide).
<P>
</UL><BR> <HR>
<P><ADDRESS>
<I>Susan Blackford <BR>
Tue May 13 09:21:01 EDT 1997</I>
</ADDRESS>
</BODY>
</HTML>
|