[Nek5000-users] Feedback Documentation

[nek5000-users at lists.mcs.anl.gov]

Hi,
I guess connected to that suggestion is the question whether one wants 
to have doxygen-type of source documentation. Personally, I would find 
that quite useful, and perhaps the easiest way of having source and 
documentation in sync.
Best regards,
philipp

On 2017-09-08 18:39, nek5000-users at lists.mcs.anl.gov wrote:
> Hi Stefan,
> 
> One thing that I think a lot of users (specifically relatively new and unexperienced Nek5000 users) can benefit from is that if there was a 1 or 2 line comment at the beginning of each subroutine that describes what the subroutine does. I realize it might not be practical to go back and modify the existing routines, but it would be nice if future additions/modifications to the code required the contributor to do this.
> 
> p.s. I am sometimes guilty of not doing this.. for example - in my most recent PR for multimesh.f. I will address this and include comments in the subroutines that I have modified in multimesh.f in my next PR.
> 
> Cheers,
> Ketan
> _______________________________________________
> Nek5000-users mailing list
> Nek5000-users at lists.mcs.anl.gov
> https://lists.mcs.anl.gov/mailman/listinfo/nek5000-users
>