12

I prefer using doxygen that supports C++ and LaTeX comments, both inline and as separate equations. This way, you will keep your comments, including, say, the rigorous mathematical formulation of the algorithm, very close to the source code. The generation of the documentation can be included in the overall workflow (say, a Makefile or CMake target, ...


5

Running the command edit interp2 allows you to see the source code of this particular function and then you can read the piece of code that deals with bicubic interpolation. In MATLAB R2011, there is even a paper being cited: "Cubic Convolution Interpolation for Digital Image Processing", Robert G. Keys, IEEE Trans. on Acoustics, Speech, and Signal ...


2

Currently there is a GMSH API in the works: https://gitlab.onelab.info/gmsh/gmsh/tree/master/api Also, there are rumors that there will be a fully documented API by version 4.0. In short, there is no documentation on the functions for GMSH (except for what is in the source all ready). But, they are planning on creating a documented version by GMSH 4.0. ...


2

The Scalapack UG link brings up a misleading web page. It looks as if there isn't any Fortran documentation, when I suppose the page is instead intended to be a title page. Clicking on the "Next" button in the upper left-hand corner brings you to the first page of Fortran interface documentation for P_GEMR2D.


1

Documentation that is automatically derived from your source code is an essential component in having up-to-date i.e. correct documentation. I can't count how many times I've seen documentation that is years behind the source code because of developer apathy towards documentation. The easy solution is to make it easy for programmers to write documentation ...


Only top voted, non community-wiki answers of a minimum length are eligible