Changeset 2628


Ignore:
Timestamp:
Mar 29, 2006, 2:39:50 PM (18 years ago)
Author:
howard
Message:

Added more definitions to Chapter 3

File:
1 edited

Legend:

Unmodified
Added
Removed
  • documentation/user_manual/anuga_user_manual.tex

    r2627 r2628  
    909909\subsection{Setters and getters of class Domain}
    910910
    911 \begin{funcdesc} {set_name}{??}
     911\begin{funcdesc} {set\_name}{name}
     912    Module: \codee{pyvolution.domain}
     913   
     914    Assigns the name \code{name} to the domain
    912915\end{funcdesc}
    913916
    914 \begin{funcdesc} {get_name}{??}
     917\begin{funcdesc} {get\_name}{}
     918    Module: \code{pyvolution.domain}
     919   
     920    Returns the name assigned to the domain by \code{set_name}. If no name has been
     921    assigned, returns `domain'.
    915922\end{funcdesc}
    916923
    917 \begin{funcdesc} {set_datadir}{??}
     924\begin{funcdesc} {set\_datadir}{name}
     925    Module: \code{pyvolution.domain}
     926   
     927    Sets the directory used for data to the value \code{name}. The default value, before
     928    \code{set\_datadir} is run, is the value \code{default_datadir} specified in \config.py}.
    918929\end{funcdesc}
    919930
    920 \begin{funcdesc} {get_datadir}{??}
     931\begin{funcdesc} {get_datadir}{}
     932    Module: \code{pyvolution.domain}
     933   
     934    Returns the data directory set by \code{set\_datadir} or, if \code{set\_datadir} has not
     935    been run, returns the value \code{default_datadir} specified in \config.py}.
    921936\end{funcdesc}
    922937
Note: See TracChangeset for help on using the changeset viewer.