GRdoc + coding guideline stuff.

Tom


git-svn-id: http://svn.cactuscode.org/flesh/trunk@1851 17b73243-c579-4c4c-a9d2-2d5706c11dac

14 files changed, 588 insertions, 65 deletions

diff --git a/src/main/Banner.c b/src/main/Banner.c
index dfc20023..e57ab7b4 100644
--- a/src/main/Banner.c
+++ b/src/main/Banner.c
@@ -5,6 +5,7 @@
    @desc 
    Routines to deal with the Cactus banners.
    @enddesc 
+   @version $Header$
  @@*/
 
 /*#define DEBUG_BANNER*/
@@ -23,11 +24,28 @@ static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_Banner_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
 static int number_banners = 0;
 static char **banner_strings = NULL;
 
-void CCTK_PrintBanners(void);
-
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
 
 
  /*@@
@@ -37,6 +55,11 @@ void CCTK_PrintBanners(void);
    @desc 
    Prints the Cactus Banner
    @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
 @@*/
 
 void CCTKi_CactusBanner(void)
@@ -73,12 +96,23 @@ void CCTKi_CactusBanner(void)
    @desc 
    Registers a string as a banner
    @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
    @var     string
    @vdesc   The banner as a C string
    @vtype   const char *
-   @vio     
+   @vio     in
    @vcomment 
+
    @endvar 
+
+   @returntype int
+   @returndesc
+   0 -- success
+   @endreturndesc
 @@*/
 
 int CCTK_RegisterBanner(const char *string)
@@ -145,12 +179,16 @@ void  CCTK_FCALL CCTK_FNAME(CCTK_RegisterBanner)
    @desc 
    Print all registered banners
    @enddesc 
-   @var     string
-   @vdesc   The banner as a C string
-   @vtype   const char *
-   @vio     
-   @vcomment 
-   @endvar 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+
+   @returntype int
+   @returndesc
+   0 -- success
+   @endreturndesc
 @@*/
 
 int CCTKi_PrintBanners(void)
@@ -179,6 +217,9 @@ int CCTKi_PrintBanners(void)
 
 }
   
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
 
 
 
diff --git a/src/main/CactusDefaultEvolve.c b/src/main/CactusDefaultEvolve.c
index 167775a5..9064378d 100644
--- a/src/main/CactusDefaultEvolve.c
+++ b/src/main/CactusDefaultEvolve.c
@@ -11,6 +11,7 @@
 /*#define DEBUG_CCTK*/
 
 #include <stdio.h>
+#include <stdlib.h>
 
 #include "cctk_Flesh.h"
 #include "cctk_Parameter.h"
diff --git a/src/main/CallStartupFunctions.c b/src/main/CallStartupFunctions.c
index f6951255..a69a1eaa 100644
--- a/src/main/CallStartupFunctions.c
+++ b/src/main/CallStartupFunctions.c
@@ -9,6 +9,7 @@
  @@*/
 
 #include <stdio.h>
+#include <stdlib.h>
 
 #include "cctk_Flesh.h"
 #include "cctk_Schedule.h"
@@ -17,6 +18,26 @@ static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_CallStartupFunctions_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
+
  /*@@
    @routine    CCTKi_CallStartupFunctions
    @date       Mon Sep 28 14:24:39 1998
@@ -29,7 +50,18 @@ CCTK_FILEVERSION(main_CallStartupFunctions_c)
    @history 
  
    @endhistory 
+   @var     ConfigData
+   @vdesc   Flesh configuration data
+   @vtype   tFleshConfig
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   @endreturndesc
 @@*/
 
 int CCTKi_CallStartupFunctions(tFleshConfig *ConfigData)
@@ -40,3 +72,7 @@ int CCTKi_CallStartupFunctions(tFleshConfig *ConfigData)
   return 0;
 }
   
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
+
diff --git a/src/main/DefaultTimers.c b/src/main/DefaultTimers.c
index 6890b6dd..3eecf7ca 100644
--- a/src/main/DefaultTimers.c
+++ b/src/main/DefaultTimers.c
@@ -20,7 +20,9 @@
 # if HAVE_SYS_TIME_H
 #  include <sys/time.h>
 # else
-#  include <time.h>
+#   if HAVE_TIME_H 
+#    include <time.h>
+#   endif
 # endif
 #endif
 
diff --git a/src/main/InitialiseCactus.c b/src/main/InitialiseCactus.c
index 7e4584de..3772f86e 100644
--- a/src/main/InitialiseCactus.c
+++ b/src/main/InitialiseCactus.c
@@ -5,9 +5,11 @@
    @desc 
    Responsible for doing any cactus specific initialisations
    @enddesc 
+   @version $Header$
  @@*/
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <time.h>
 
 #include "cctk_Flesh.h"
@@ -19,23 +21,44 @@
 #include "cctki_Bindings.h"
 #include "cctki_Schedule.h"
 
-int CCTKi_InitialiseScheduler(tFleshConfig *ConfigData);
+
+static char *rcsid = "$Header$";
+
+CCTK_FILEVERSION(main_InitialiseCactus_c)
+
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+static int CCTKi_InitialiseScheduler(tFleshConfig *ConfigData);
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
 int CCTKi_InitialiseSubsystemDefaults(void);
 int CCTKi_ProcessEnvironment(int *argc, char ***argv,tFleshConfig *ConfigData);
 int CCTKi_BindingsParameterRecoveryInitialise(void);
 
-#define CCTK_PRINTSEPARATOR \
-  printf("--------------------------------------------------------------------------------\n");
-
-static char *rcsid = "$Header$";
+int CCTKi_ProcessCommandLine(int *inargc, char ***inargv, tFleshConfig *ConfigData);
+int CCTKi_ProcessEnvironment(int *argc, char ***argv,tFleshConfig *ConfigData);
 
-CCTK_FILEVERSION(main_InitialiseCactus_c)
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
 
-int ProcessCommandLine(int *inargc, char ***inargv, tFleshConfig *ConfigData);
-int ProcessEnvironment(int *argc, char ***argv,tFleshConfig *ConfigData);
+#define CCTK_PRINTSEPARATOR \
+  printf("--------------------------------------------------------------------------------\n");
 
 static time_t startuptime;
-  
+
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
 
  /*@@
    @routine    CCTKi_InitialiseCactus
@@ -71,6 +94,10 @@ static time_t startuptime;
  
    @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   @endreturndesc
 @@*/
 int CCTKi_InitialiseCactus(int *argc, char ***argv, tFleshConfig *ConfigData)
 {
@@ -99,6 +126,9 @@ int CCTKi_InitialiseCactus(int *argc, char ***argv, tFleshConfig *ConfigData)
   return 0;
 }
 
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
 
  /*@@
    @routine    CCTKi_InitialiseScheduler
@@ -112,10 +142,21 @@ int CCTKi_InitialiseCactus(int *argc, char ***argv, tFleshConfig *ConfigData)
    @history 
  
    @endhistory 
+   @var     ConfigData
+   @vdesc   Flesh configuration data
+   @vtype   tFleshConfig
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   @endreturndesc
 @@*/
 
-int CCTKi_InitialiseScheduler(tFleshConfig *ConfigData)
+static int CCTKi_InitialiseScheduler(tFleshConfig *ConfigData)
 {
   int retcode;
   extern void CCTKi_SetParameterSetMask(int mask);
@@ -139,7 +180,6 @@ int CCTKi_InitialiseScheduler(tFleshConfig *ConfigData)
 }
 
 
-
  /*@@
    @routine    CCTK_RunTime
    @date       Tue Oct 3 2000
@@ -153,9 +193,13 @@ int CCTKi_InitialiseScheduler(tFleshConfig *ConfigData)
  
    @endhistory 
 
+   @returntype int
+   @returndesc
+   The number of seconds since the run started.
+   @endreturndesc
 @@*/
 
-int CCTK_RunTime()
+int CCTK_RunTime(void)
 {
   int retval;
   time_t currenttime;
@@ -166,6 +210,3 @@ int CCTK_RunTime()
 
   return retval;
 }
-
-
-
diff --git a/src/main/InitialiseDataStructures.c b/src/main/InitialiseDataStructures.c
index cb938387..f6ebf907 100644
--- a/src/main/InitialiseDataStructures.c
+++ b/src/main/InitialiseDataStructures.c
@@ -3,8 +3,9 @@
    @date      Wed Jan 13 20:28:08 1999
    @author    Tom Goodale
    @desc 
-   
+   Initialise various datastructures.
    @enddesc 
+   @version $Header$
  @@*/
 
 #include <stdio.h>
@@ -16,12 +17,32 @@
 #include "cctki_ActiveThorns.h"
 #include "cctki_Cache.h"
 
-int CCTKi_RegisterDefaultTimerFunctions(void);
-
 static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_InitialiseDataStructures_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+int CCTKi_RegisterDefaultTimerFunctions(void);
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
+
  /*@@
    @routine    CCTKi_InitialiseDataStructures
    @date       Wed Jan 20 09:27:56 1999
@@ -34,7 +55,18 @@ CCTK_FILEVERSION(main_InitialiseDataStructures_c)
    @history 
  
    @endhistory 
+   @var     ConfigData
+   @vdesc   Flesh configuration data
+   @vtype   tFleshConfig
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   @endreturndesc
 @@*/
 
 int CCTKi_InitialiseDataStructures(tFleshConfig *ConfigData)
@@ -51,17 +83,13 @@ int CCTKi_InitialiseDataStructures(tFleshConfig *ConfigData)
   ConfigData->timer[ELLIPTIC] = CactusNewTimer();
 #endif
 
-
-  /* Initialise appropriate subsystems. */
-
-  /*  CCTKi_BindingsImplementationsInitialise();*/
-  /*  CCTKi_BindingsParametersInitialise();*/
-  /*  CCTKi_BindingsVariablesInitialise(); */
-  /*  CCTKi_BindingsScheduleInitialise(); */
-
   CCTKi_ActivateThorn("Cactus");
   CCTKi_SetupCache();
 
   return 0;
 }
 
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
+
diff --git a/src/main/Names.c b/src/main/Names.c
index c9311d6c..75441f0c 100644
--- a/src/main/Names.c
+++ b/src/main/Names.c
@@ -69,7 +69,26 @@ static uHash *VariableData = NULL;
    @history 
  
    @endhistory 
+   @var     gname
+   @vdesc   Name of the group
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     gnum
+   @vdesc   Group number
+   @vtype   int
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   -1 - out of memory
+   @endreturndesc
 @@*/
 int CCTKi_NamesStoreGroup(const char *gname, int gnum)
 {
@@ -118,7 +137,33 @@ int CCTKi_NamesStoreGroup(const char *gname, int gnum)
    @history 
  
    @endhistory 
+   @var     name
+   @vdesc   Name of the variable
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     vnum
+   @vdesc   Variable number
+   @vtype   int
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     gnum
+   @vdesc   Number of group containing variable.
+   @vtype   int
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   -1 - out of memory
+   @endreturndesc
 @@*/
 int CCTKi_NamesStoreVariable(const char *name, int vnum, int gnum)
 {
@@ -167,6 +212,27 @@ int CCTKi_NamesStoreVariable(const char *name, int vnum, int gnum)
    @history 
  
    @endhistory 
+   @var     gname
+   @vdesc   Name of the group
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     gnum
+   @vdesc   Group number
+   @vtype   int *
+   @vio     out
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   0  - success
+   -1 - group doesn't exist
+   -2 - no groups exist
+   @endreturndesc
 
 @@*/
 int CCTKi_NamesRetrieveGroupNum(const char *gname, int *gnum)
@@ -212,7 +278,34 @@ int CCTKi_NamesRetrieveGroupNum(const char *gname, int *gnum)
    @history 
  
    @endhistory 
-
+   @var     name
+   @vdesc   Name of the variable
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     vnum
+   @vdesc   Variable number
+   @vtype   int *
+   @vio     out
+   @vcomment 
+ 
+   @endvar 
+   @var     gnum
+   @vdesc   Number of group containing variable.
+   @vtype   int *
+   @vio     out
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   0  - success
+   -1 - variable doesn't exist
+   -2 - no variable exists
+   @endreturndesc
 @@*/
 int CCTKi_NamesRetrieveVariableNum(const char *name, int *vnum, int *gnum)
 {
@@ -266,7 +359,25 @@ int CCTKi_NamesRetrieveVariableNum(const char *name, int *vnum, int *gnum)
    @hdate Thu Mar  9 11:04:48 2000 @hauthor Tom Goodale
    @hdesc Copied from Util_HashHash and modified to be case independent. 
    @endhistory 
+   @var     klen
+   @vdesc   Key length
+   @vtype   unsigned int
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     key
+   @vdesc   The key
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype unsigned int
+   @returndesc
+   The hash value
+   @endreturndesc
 @@*/
 static unsigned int CaseIndependentHash(unsigned int klen, 
                                         const char *key)
diff --git a/src/main/Parameters.c b/src/main/Parameters.c
index 30bddfdf..36815a7c 100644
--- a/src/main/Parameters.c
+++ b/src/main/Parameters.c
@@ -1614,7 +1614,7 @@ static int ParameterSetInteger(t_param *param, const char *value)
   int inval;
   CCTK_INT *val;
 
-  inval = atoi(value);
+  inval = strtol(value,NULL,0);
   val = (CCTK_INT *)param->data;
   retval = -1;
   for(range = param->props->range; range ; range = range->next)
diff --git a/src/main/ProcessCommandLine.c b/src/main/ProcessCommandLine.c
index c8eb6d85..69657b7e 100644
--- a/src/main/ProcessCommandLine.c
+++ b/src/main/ProcessCommandLine.c
@@ -5,23 +5,45 @@
    @desc 
    Routines to deal with the command line arguments.
    @enddesc 
+   @version $Header$
  @@*/
 #include <stdio.h>
 #include <stdlib.h>
 
-#include "CommandLine.h"
 #include "cctk_Flesh.h"
 #include "cctk_GNU.h"
 
+#include "CommandLine.h"
+
 static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_ProcessCommandLine_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
 static char *parameter_file_name=NULL;
 
-static int argc;
+static int argc = 0;
+
+static char **argv = NULL;
 
-static char **argv;
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
 
  /*@@
    @routine    CCTKi_ProcessCommandLine
@@ -35,6 +57,32 @@ static char **argv;
    @history 
  
    @endhistory 
+   @var     inargc
+   @vdesc   Number of runtime arguments
+   @vtype   int *
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
+   @var     inargv
+   @vdesc   Command line arguments
+   @vtype   char ***
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
+   @var     ConfigData
+   @vdesc   Flesh configuration data
+   @vtype   tFleshConfig
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   0 -- success
+   @endreturndesc
 
 @@*/
 int CCTKi_ProcessCommandLine(int *inargc, char ***inargv, tFleshConfig *ConfigData)
@@ -126,7 +174,18 @@ int CCTKi_ProcessCommandLine(int *inargc, char ***inargv, tFleshConfig *ConfigDa
    @history 
  
    @endhistory 
+   @var     outargv
+   @vdesc   Place to dump the command line arguments
+   @vtype   char ***
+   @vio     out
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   The number of command line arguments.
+   @endreturndesc
 @@*/
 int CCTK_CommandLine(char ***outargv)
 {
@@ -148,6 +207,25 @@ int CCTK_CommandLine(char ***outargv)
    @history 
  
    @endhistory 
+   @var     len
+   @vdesc   The length of the incoming string
+   @vtype   int
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     filename
+   @vdesc   String to contain the filename
+   @vtype   char *
+   @vio     out
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   The length of the returned string.
+   @endreturndesc
 
 @@*/
 int CCTK_ParameterFilename(int len, char *filename)
@@ -173,3 +251,9 @@ void CCTK_FCALL CCTK_FNAME(CCTK_ParameterFilename)
   *retval = CCTK_ParameterFilename(*len,name);
 }
 
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
+
+
+
diff --git a/src/main/ProcessEnvironment.c b/src/main/ProcessEnvironment.c
index 30d80197..d82be440 100644
--- a/src/main/ProcessEnvironment.c
+++ b/src/main/ProcessEnvironment.c
@@ -5,6 +5,7 @@
    @desc 
    Checks the environment for various settings, and acts on them.
    @enddesc 
+   @version $Header$
  @@*/
 
 #include <stdio.h>
@@ -16,6 +17,26 @@
 #include "mpi.h"
 #endif
 
+static char *rcsid = "$Header$";
+
+CCTK_FILEVERSION(main_ProcessEnvironment_c)
+
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
 #ifdef CCTK_MPI
 #define CACTUS_MPI_ERROR(xf)                                                  \
           do                                                                  \
@@ -38,16 +59,55 @@
           } while (0)
 #endif
 
-#include "cctk_Flesh.h"
-
-static char *rcsid = "$Header$";
-
-CCTK_FILEVERSION(main_ProcessEnvironment_c)
-
 #ifdef CCTK_MPI
 char MPI_Active = 0;
 #endif
 
+
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
+
+ /*@@
+   @routine    CCTKi_ProcessEnvironment
+   @date       Fri Feb 26 11:20:15 1999
+   @author     Tom Goodale
+   @desc 
+   
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+   @var     argc
+   @vdesc   Number of arguments
+   @vtype   int *
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
+   @var     argv
+   @vdesc   Argument list
+   @vtype   char ***
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
+   @var     ConfigData
+   @vdesc   Flesh configuration data
+   @vtype   tFleshConfig
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   0  - success
+   @endreturndesc
+
+@@*/
 int CCTKi_ProcessEnvironment(int *argc, char ***argv,tFleshConfig *ConfigData)
 {
   
@@ -66,3 +126,6 @@ int CCTKi_ProcessEnvironment(int *argc, char ***argv,tFleshConfig *ConfigData)
   return 0;
 }
 
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
diff --git a/src/main/ProcessParameterDatabase.c b/src/main/ProcessParameterDatabase.c
index 163abb47..39a36531 100644
--- a/src/main/ProcessParameterDatabase.c
+++ b/src/main/ProcessParameterDatabase.c
@@ -5,6 +5,7 @@
    @desc 
    Routines to determine the parameters and store them.
    @enddesc 
+   @version $Header$
  @@*/
 
 #include <stdio.h>
@@ -20,10 +21,30 @@ static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_ProcessParameterDatabase_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
 int ParseFile(FILE *ifp, 
               int (*set_function)(const char *, const char *),tFleshConfig *ConfigData);
+
 void CCTKi_SetParameterSetMask(int mask);
 
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
 
  /*@@
    @routine    CCTKi_ProcessParameterDatabase
@@ -37,7 +58,19 @@ void CCTKi_SetParameterSetMask(int mask);
    @history 
  
    @endhistory 
+   @var     ConfigData
+   @vdesc   Flesh configuration data
+   @vtype   tFleshConfig
+   @vio     inout
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc
+   0  - success
+   1  - unable to open parameter file
+   @endreturndesc
 @@*/
 int CCTKi_ProcessParameterDatabase(tFleshConfig *ConfigData)
 {
@@ -75,3 +108,8 @@ int CCTKi_ProcessParameterDatabase(tFleshConfig *ConfigData)
   return retval;
 }
 
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
+
+
diff --git a/src/main/SetParams.c b/src/main/SetParams.c
index 6d110b8c..03fc7e9d 100644
--- a/src/main/SetParams.c
+++ b/src/main/SetParams.c
@@ -5,6 +5,7 @@
    @desc 
    
    @enddesc 
+   @version $Header$
  @@*/
 
 #include <stdio.h>
@@ -19,23 +20,37 @@
 #include "cctk_WarnLevel.h"
 #include "cctk_Misc.h"
 #include "cctk_Flesh.h"
+#include "cctk_Parameter.h"
 
 #include "ParameterBindings.h"
 
-static int ReallySetParameter(
-   const char *parameter, 
-   const char *value
-   );
-int CCTK_ParameterSet(
-   const char *name,
-   const char *thorn,
-   const char *value
-   );
-       
 static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_SetParams_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+static int ReallySetParameter(const char *parameter, 
+                              const char *value);
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
+
  /*@@
    @routine    CCTKi_SetParameter
    @date       Tue Jan 12 19:25:37 1999
@@ -48,7 +63,27 @@ CCTK_FILEVERSION(main_SetParams_c)
    @history 
  
    @endhistory 
-
+   @var     parameter
+   @vdesc   Name of a parameter
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     value
+   @vdesc   Value of the parameter
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   0  - success
+   -1 - unknown parameter
+   -? - other error
+   @endreturndesc
 @@*/
 int CCTKi_SetParameter(const char *parameter, const char *value)
 {
@@ -92,7 +127,6 @@ int CCTKi_SetParameter(const char *parameter, const char *value)
   }
   else
   {     
-    /*   retval = CCTKi_BindingsParameterSet(parameter, value);*/
     retval = ReallySetParameter(parameter, value); 
   }
   
@@ -111,6 +145,44 @@ int CCTKi_SetParameter(const char *parameter, const char *value)
   return retval;
 }
 
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
+
+
+ /*@@
+   @routine    ReallySetParameter
+   @date       Tue Jan 12 19:25:37 1999
+   @author     Tom Goodale
+   @desc 
+   Really sets the parameter value.
+   @enddesc 
+   @calls     
+   @calledby   
+   @history 
+ 
+   @endhistory 
+   @var     parameter
+   @vdesc   Name of a parameter
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     value
+   @vdesc   Value of the parameter
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+
+   @returntype int
+   @returndesc
+   0  - success
+   -1 - unknown parameter
+   @endreturndesc
+@@*/
 static int ReallySetParameter(const char *parameter, const char *value)
 {
   int retval;
@@ -122,15 +194,11 @@ static int ReallySetParameter(const char *parameter, const char *value)
   int retval_thorn;
 
 
-  /*
-    CCTKi_BindingsParameterHelp(optarg,"%s",stdout);
-  */
- 
   Util_SplitString(&imp, &param, parameter, "::");
 
   retval = -1;
-  /* If param is null, there were no colons in the input */
 
+  /* If param is null, there were no colons in the input */
   if(!param)
   {
     retval = CCTK_ParameterSet(parameter, imp, value);
@@ -183,5 +251,4 @@ static int ReallySetParameter(const char *parameter, const char *value)
   free(param);
 
   return retval;
-
 }
diff --git a/src/main/Subsystems.c b/src/main/Subsystems.c
index 19f6fadf..5f63456e 100644
--- a/src/main/Subsystems.c
+++ b/src/main/Subsystems.c
@@ -27,6 +27,11 @@ CCTK_FILEVERSION(main_Subsystems_c)
  
    @endhistory 
 
+   @returntype int
+   @returndesc
+   0  - success
+   @endreturndesc
+
 @@*/
 
 int CCTKi_InitialiseSubsystemDefaults(void)
diff --git a/src/main/flesh.cc b/src/main/flesh.cc
index ccb57206..58edc68c 100644
--- a/src/main/flesh.cc
+++ b/src/main/flesh.cc
@@ -5,6 +5,7 @@
    @desc 
    Main program file for cactus.
    @enddesc 
+   @version $Header$
  @@*/
 #include <stdio.h>
 
@@ -45,6 +46,11 @@ CCTK_FILEVERSION(main_flesh_cc)
  
    @endvar 
 
+   @returntype int
+   @returndesc
+   0 -- success
+   @endreturndesc
+
 @@*/
 int main(int argc, char **argv)
 {