From: Ralf Hartmann <Ralf.Hartmann@dlr.de>
Date: Fri, 23 Sep 2005 08:10:07 +0000 (+0000)
Subject: Function parameters. Add doc.
X-Git-Tag: v8.0.0~13092
X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d547dd2251ee4477a6386e47d09ac57d5a32fa78;p=dealii.git

Function parameters. Add doc.


git-svn-id: https://svn.dealii.org/trunk@11511 0785d39b-7218-0410-832d-ea1e28bc413d
---

diff --git a/deal.II/deal.II/include/grid/grid_in.h b/deal.II/deal.II/include/grid/grid_in.h
index 8f65ae5604..036c127dbe 100644
--- a/deal.II/deal.II/include/grid/grid_in.h
+++ b/deal.II/deal.II/include/grid/grid_in.h
@@ -202,7 +202,7 @@ class GridIn
 				      * #default_format variable is
 				      * used.
 				      */
-    void read (std::istream &, Format format=Default);
+    void read (std::istream &in, Format format=Default);
     
 				     /**
 				      * Open the file given by the
@@ -212,40 +212,44 @@ class GridIn
 				      * to find files. The file class
 				      * used is <code>MESH</code>.
 				      */
-    void read (const std::string&, Format format=Default);
+    void read (const std::string &in, Format format=Default);
     
 				     /**
 				      * Read grid data from an ucd file.
 				      * Numerical data is ignored.
 				      */
-    void read_ucd (std::istream &);
+    void read_ucd (std::istream &in);
 
 				     /**
 				      * Read grid data from a file
 				      * containing data in the DB mesh
 				      * format.
 				      */
-    void read_dbmesh (std::istream &);
+    void read_dbmesh (std::istream &in);
     
 				     /**
 				      * Read grid data from a file
 				      * containing data in the XDA
 				      * format.
 				      */
-    void read_xda (std::istream &);
+    void read_xda (std::istream &in);
     
     				     /**
 				      * Read grid data from an msh file.
 				      */
-    void read_msh (std::istream &);
+    void read_msh (std::istream &in);
     
     				     /**
-				      * Read grid data from a netcdf
-				      * file.  This requires the
+				      * Read grid data from a NetCDF
+				      * file. The only data format
+				      * currently supported is the
+				      * <tt>TAU grid format</tt>.
+				      *
+				      * This function requires the
 				      * library to be linked with the
-				      * netcdf library.
+				      * NetCDF library.
 				      */
-    void read_netcdf (const std::string &);
+    void read_netcdf (const std::string &filename);
     
 				     /**
 				      * Returns the standard suffix