Fixed gcc verbose warnings about missing prototypes and use of variables

named 'index' which hides a global function index(3).
Also polished grdocs, added missing version and rcs IDs.


git-svn-id: http://svn.cactuscode.org/arrangements/CactusBase/IOASCII/trunk@32 94b1c47f-dcfd-45ef-a468-0854c0e9e350

1 files changed, 48 insertions, 39 deletions

diff --git a/src/ChooseOutput.c b/src/ChooseOutput.c
index 5997fc7..76153a6 100644
--- a/src/ChooseOutput.c
+++ b/src/ChooseOutput.c
@@ -1,15 +1,12 @@
 /*@@
-  @file ChooseOutput.c
-  @author Gabrielle Allen
-  @date July 6 2000
+  @file      ChooseOutput.c
+  @author    Gabrielle Allen
+  @date      July 6 2000
   @desc
-  Choose what data to write for different IO methods in IOASCII
-  @enddesc 
+             Choose what data to write for different IO methods in IOASCII
+  @enddesc
 
-  @history
-  @hauthor 
-  @hdesc 
-  @version $Header$
+  @version $Id$
 @@*/
 
 #include <stdlib.h>
@@ -20,24 +17,34 @@
 #include "CactusBase/IOUtil/src/ioutil_Utils.h"
 #include "ioASCIIGH.h"
 
+/* the rcs ID and its dummy function to use it */
 static char *rcsid = "$Header$";
 CCTK_FILEVERSION(CactusBase_IOASCII_ChooseOutput_c)
 
-/*@@
-  @routine IOASCII_Choose1D
-  @author Gabrielle Allen
-  @date July 6 2000
-  @desc
-  Use parameters to choose the 1D slices through the output data. 
-  @enddesc
 
-  @history
-  @hauthor 
-  @hdesc 
-  @version $Header$
-@@*/
+/* prototypes of routines defined in this source file */
+void IOASCII_Choose1D (cGH *GH);
+void IOASCII_Choose2D (cGH *GH);
+
+
+ /*@@
+   @routine   IOASCII_Choose1D
+   @author    Gabrielle Allen
+   @date      July 6 2000
+   @desc
+              Use parameters to choose the 1D slices through the output data. 
+   @enddesc
 
-void IOASCII_Choose1D(CCTK_ARGUMENTS)
+   @calls     CCTK_ParameterQueryTimesSet
+              IOUtil_1DLines
+
+   @var       GH
+   @vdesc     Pointer to CCTK grid hierarchy
+   @vtype     cGH *
+   @vio       in
+   @endvar
+@@*/
+void IOASCII_Choose1D (cGH *GH)
 {
   DECLARE_CCTK_PARAMETERS
   int i;
@@ -46,7 +53,7 @@ void IOASCII_Choose1D(CCTK_ARGUMENTS)
   CCTK_REAL *origin_phys[3];        /* Specify output lines with coordinates */
 
 
-  myGH = (asciiioGH *) cctkGH->extensions[CCTK_GHExtensionHandle ("IOASCII")];
+  myGH = (asciiioGH *) CCTK_GHExtension (GH, "IOASCII");
 
   /* Set up lines to be output */
   origin_phys[0] = (CCTK_REAL *) malloc (3*3 * sizeof (CCTK_REAL));
@@ -195,7 +202,7 @@ void IOASCII_Choose1D(CCTK_ARGUMENTS)
 
   for (i = 1; i <= CCTK_MaxDim(); i++)
   {
-    IOUtil_1DLines (cctkGH, i, origin_index, origin_phys, myGH->spxyz[i-1]);
+    IOUtil_1DLines (GH, i, origin_index, origin_phys, myGH->spxyz[i-1]);
   }
 
   free (origin_phys[0]);
@@ -203,22 +210,24 @@ void IOASCII_Choose1D(CCTK_ARGUMENTS)
 }
 
 
+ /*@@
+   @routine   IOASCII_Choose2D
+   @author    Gabrielle Allen
+   @date      July 6 2000
+   @desc
+              Use parameters to choose the 2D slices through the output data. 
+   @enddesc
 
-/*@@
-  @routine IOASCII_Choose2D
-  @author Gabrielle Allen
-  @date July 6 2000
-  @desc
-  Use parameters to choose the 2D planes through the output data. 
-  @enddesc
+   @calls     CCTK_ParameterQueryTimesSet
+              IOUtil_2DPlanes
 
-  @history
-  @hauthor 
-  @hdesc 
-  @version $Header$
+   @var       GH
+   @vdesc     Pointer to CCTK grid hierarchy
+   @vtype     cGH *
+   @vio       in
+   @endvar
 @@*/
-
-void IOASCII_Choose2D(CCTK_ARGUMENTS)
+void IOASCII_Choose2D (cGH *GH)
 {
   DECLARE_CCTK_PARAMETERS
   int i;
@@ -227,7 +236,7 @@ void IOASCII_Choose2D(CCTK_ARGUMENTS)
   CCTK_REAL origin_phys[3];         /* Specify output planes by coordinates */
 
 
-  myGH = (asciiioGH *) cctkGH->extensions[CCTK_GHExtensionHandle ("IOASCII")];
+  myGH = (asciiioGH *) CCTK_GHExtension (GH, "IOASCII");
 
   /* Set parameters using 
      1. Indices from IOASCII
@@ -300,6 +309,6 @@ void IOASCII_Choose2D(CCTK_ARGUMENTS)
 
   for (i = 1; i <= CCTK_MaxDim(); i++)
   {
-    IOUtil_2DPlanes (cctkGH, i, origin_index, origin_phys, myGH->sp2xyz[i-1]);
+    IOUtil_2DPlanes (GH, i, origin_index, origin_phys, myGH->sp2xyz[i-1]);
   }
 }