[Developers] Libraries

[John Sibert]

Hi Steve
This all looks really good. Johnoel and I think the best place stuff 
would be to put the statslib directory in the contrib directory of the 
trunk.

With regard to doxygen input, all you need to do is add your directory 
to the INPUT section,
../../conytrib/statslib

I have added stuff to mainpage.txt that creates a Contributed module 
with sub-headings for Statistical and Ecological libraries. You should 
insert \ingroup STATLIB in the doxygen comment block for each function.

(Mollie, if you are reading this you should insert \ingroup ECOL in the 
doxygen comment block for each function when you get your ecology 
functions ready to roll.)

I also suggest using the \author command to identify authorship of each 
function.
Thanks,
John

On 07/12/2011 11:47 AM, Steve Martell wrote:
> Hi Johnoel,
>
> I'm about to submit this Libraries Project to the ADMB Foundation with some examples etc.  The rush is that Mark Maunder needs me to invoice this before July 15, 2011.  I'll probably just zip the whole think up and send it off to Mark and Anders as a deliverable.  However, I forsee that I will be continually adding to this library over time and would like to add it to the repository so it can easily be updated and maintained.
>
> So, I'm calling on your expertise here to help me launch this thing.  Here is what I propose:
>
> 1) under the trunk/src to add another directory called "statslib"
>
> 2) modify the make files to include the statslib in the build
>
> 3) modify the Doxyfile INPUT section to include the statslib directory
>    	../../src/statslib so that the API documentation includes the libraries.
>
> 4)<optional>  add a testLib ADMB program to the verify list
>
> Right now I have a single header file ("statslib.h") for all the libraries and I would leave this out of the build (ie. none of the existing src code makes reference to the "statslib.h".  If a user wishes to use functions from this library then the user would have to explicity #include<statslib.h>  in the GLOBALS_SECTION of their template file (This is what we discussed at NCEAS, and I think it was Mark Maunders suggestion).
>
> Also, I've used doxygen comments throughout the library files so I would presume the buildbot would help manage the API documentation.
>
> I can probably tackle the make files for linux (linux.mak) to do this on my local machine, also create an objects.lst and optg32-rh8-laplace.mak in the statslib directory, but I could not do this for other platforms (at least test it).
>
> How does this all sound?
>
> Steve
> _______________________________________________
> Developers mailing list
> Developers at admb-project.org
> http://lists.admb-project.org/mailman/listinfo/developers
>

-- 
John Sibert
Emeritus Researcher, SOEST
University of Hawaii at Manoa

Visit the ADMB project http://admb-project.org/