libROM icon indicating copy to clipboard operation
libROM copied to clipboard

code documentation

Open gokhalen opened this issue 2 years ago • 1 comments

Is the code documentation at

https://software.llnl.gov/libROM/html/index.html

a little behind the current version of libROM?

For instance I cannot seem to find: "SampleMeshManager" in the documentation.

Nachiket

gokhalen avatar Feb 27 '23 04:02 gokhalen

Thank you, @gokhalen, for pointing this out. The documentation on that webpage is lagging. I do not see any of the MFEM-related code. Also, there is documentation for DMD but not NonuniformDMD, etc. We should update this. In the meantime, I would recommend the documentation in the code, especially the header files.

dylan-copeland avatar Feb 27 '23 18:02 dylan-copeland