TedStudley / mc-mini

Simple Stokes+Advection/Diffusion solver.
0 stars 4 forks source link

Project is Poorly Commented #11

Open TedStudley opened 8 years ago

TedStudley commented 8 years ago

I was really bad about properly commenting the code when I wrote it. This isn't good for readability, and means that we won't really get much out of Doxygen when we get it working.

Add descriptions to code classes and functions documenting what they do, in JavaDoc/Doxygen format. Variables and the inner workings of functions don't really need to be commented unless it's difficult to understand what they're for/what they do.