Changeset 2628

Timestamp:

Mar 29, 2006, 2:39:50 PM (18 years ago)

Author:

howard

Message:

Added more definitions to Chapter 3

File:

• documentation/user_manual/anuga_user_manual.tex (modified) (1 diff)

documentation/user_manual/anuga_user_manual.tex

@@ -909 +909 @@
 \subsection{Setters and getters of class Domain}
 
-\begin{funcdesc} {set_name}{??}
+\begin{funcdesc} {set\_name}{name}
+    Module: \codee{pyvolution.domain}
+    
+    Assigns the name \code{name} to the domain
 \end{funcdesc}
 
-\begin{funcdesc} {get_name}{??}
+\begin{funcdesc} {get\_name}{}
+    Module: \code{pyvolution.domain}
+    
+    Returns the name assigned to the domain by \code{set_name}. If no name has been
+    assigned, returns `domain'.
 \end{funcdesc}
 
-\begin{funcdesc} {set_datadir}{??}
+\begin{funcdesc} {set\_datadir}{name}
+    Module: \code{pyvolution.domain}
+    
+    Sets the directory used for data to the value \code{name}. The default value, before
+    \code{set\_datadir} is run, is the value \code{default_datadir} specified in \config.py}.
 \end{funcdesc}
 
-\begin{funcdesc} {get_datadir}{??}
+\begin{funcdesc} {get_datadir}{}
+    Module: \code{pyvolution.domain}
+    
+    Returns the data directory set by \code{set\_datadir} or, if \code{set\_datadir} has not
+    been run, returns the value \code{default_datadir} specified in \config.py}.
 \end{funcdesc}