[gmx-developers] Gromacs doxygen documentation

[Andy Somogyi]

Hi,

I have a version of the docs ready. Mostly what I've done is re-format the existing docs in doxygen format, and added a good bit of clarifications that I've figured out. This is nowhere near complete though. 

So, even though this is not the final docs, do you think I should push it to gerrit?

If anyone wants to have a look, here it is, just updated with origin a few minutes ago. Please ignore everything in the src/programs/toptest dir.

http://github.com/AndySomogyi/gromacs


On Jul 28, 2012, at 4:12 AM, Mark Abraham wrote:

> On 28/07/2012 4:06 AM, Christoph Junghans wrote:
>> Hi Andy,
>> 
>> 2012/7/27 Andy Somogyi <andy.somogyi at gmail.com>:
>>> Hi All.
>>> 
>>> We're going to be using Gromacs as a platform for developing various coarse
>>> grained and long range electrostatics ides.
>>> 
>>> In preparation for this work, I've been adding doxygen formatted
>>> documentation to all the Gromacs functions and structures as I figure out
>>> what they do.
>> Good job, I will have a look at it.
>> 
>>> So, hopefully this documentation will be of use to others. This will be an
>>> on-going process, I'll probably pull once a day from the source github repo.
>> If you reach the point, where it would make sense to merge the stuff
>> back in the master branch, please upload the changes to
>> gerrit.gromacs.org.
> 
> Indeed, sounds excellent. And do ask questions on gmx-developers. Also perhaps http://www.gromacs.org/Developer_Zone/Programming_Guide/Doxygen and/or http://www.gromacs.org/Developer_Zone/Programming_Guide/Comments_In_Code will be helpful (all though all will agree that code documentation in GROMACS is only a shadow of what it could/should be).
> 
> Mark
> 
>> 
>> Cheers,
>> 
>> Christoph
>> 
>>> All these documentation updates are available in my public github fork:
>>> 
>>> http://github.com/AndySomogyi/gromacs
>>> 
>>> Please ignore the /src/programs/toptest directory.
>>> 
>>> --
>>> gmx-developers mailing list
>>> gmx-developers at gromacs.org
>>> http://lists.gromacs.org/mailman/listinfo/gmx-developers
>>> Please don't post (un)subscribe requests to the list. Use the
>>> www interface or send it to gmx-developers-request at gromacs.org.
>> 
>> 
> 
> -- 
> gmx-developers mailing list
> gmx-developers at gromacs.org
> http://lists.gromacs.org/mailman/listinfo/gmx-developers
> Please don't post (un)subscribe requests to the list. Use the www interface or send it to gmx-developers-request at gromacs.org.