grdoc, style-guidelines, ...

Tom


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

1 files changed, 57 insertions, 1 deletions

diff --git a/src/main/FortranWrappers.c b/src/main/FortranWrappers.c
index d0312044..3ebed5c6 100644
--- a/src/main/FortranWrappers.c
+++ b/src/main/FortranWrappers.c
@@ -5,6 +5,7 @@
    @desc 
    File for dealing with fortran wrapper functions.
    @enddesc 
+   @version $Header$
  @@*/
 
 #include <stdlib.h>
@@ -18,8 +19,28 @@ static char *rcsid = "$Header$";
 
 CCTK_FILEVERSION(main_FortranWrappers_c)
 
+/********************************************************************
+ *********************     Local Data Types   ***********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Local Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ ********************* Other Routine Prototypes *********************
+ ********************************************************************/
+
+/********************************************************************
+ *********************     Local Data   *****************************
+ ********************************************************************/
+
 static pNamedData *registry = NULL;
 
+/********************************************************************
+ *********************     External Routines   **********************
+ ********************************************************************/
+
  /*@@
    @routine    CCTKi_RegisterFortranWrapper
    @date       Sat Sep 18 00:51:21 1999
@@ -32,9 +53,28 @@ static pNamedData *registry = NULL;
    @history 
  
    @endhistory 
+   @var     name
+   @vdesc   name of the wrapper function
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
+   @var     function
+   @vdesc   Wrapper function
+   @vtype   int (*)(void *, void *)
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int
+   @returndesc 
+   The return code of StoreNamedData
+   @endreturndesc
 @@*/
-int CCTKi_RegisterFortranWrapper(const char *name, int (*function)(void *, void *))
+int CCTKi_RegisterFortranWrapper(const char *name, 
+                                 int (*function)(void *, void *))
 {
   int retcode;
   retcode = StoreNamedData(&registry, name, (void *)function);
@@ -55,9 +95,25 @@ int CCTKi_RegisterFortranWrapper(const char *name, int (*function)(void *, void
    @history 
  
    @endhistory 
+   @var     name
+   @vdesc   Name of the wrapper
+   @vtype   const char *
+   @vio     in
+   @vcomment 
+ 
+   @endvar 
 
+   @returntype int (*)(void *,void *)
+   @returndesc 
+   The wrapper function
+   @endreturndesc
 @@*/
 int (*CCTKi_FortranWrapper(const char *name))(void *, void *)
 {
   return (int (*)(void *,void *))GetNamedData(registry, name);
 }
+
+/********************************************************************
+ *********************     Local Routines   *************************
+ ********************************************************************/
+