[MITgcm-devel] RE: not sure what to do

[Chris Hill]

D.,

  The thing that is needed is

   1 - pkg/ document that is written for a human being and that is not
generated automatically.
   2 - inline API stuff for the key interfaces to the other pieces and key
internal interfaces. 

 It is best to add references and figures in 1.

 You can add references to (2) in (1). The protex stuff also includes a
level option (Ed added this) that behaves like a "verbosity" thing in
debugging, so you can indicate which routines you want generaed for a
generla document versus for a detailed document.

Chris

> -----Original Message-----
> From: Dimitris Menemenlis [mailto:menemenlis at jpl.nasa.gov] 
> Sent: Wednesday, May 05, 2004 3:33 AM
> To: Edward H. Hill III
> Cc: Christopher N. Hill
> Subject: Re: not sure what to do
> 
> OK, just for fun, I have started putting some stuff in the 
> ApiReference for kpp, sbo, and seaice.  Just placeholders for now.
> 
> Some questions:
> Can you add figures and BibTeX-style references.
> What are the non-standard Fortran bits of SBO?
> 
> A comment:
> Are you sure you want to document every single routine and 
> variable as you did for gad_advection.
> Less in this case might be better?
> 
> D.
> 
> --
> Dimitris Menemenlis <menemenlis at jpl.nasa.gov> Jet Propulsion 
> Lab, California Insitute of Technology MS 300-323, 4800 Oak 
> Grove Dr, Pasadena CA 91109-8099
> tel: 818-354-1656;  fax: 818-393-6720
>