wo80 / arpackpp-doc Goto Github PK

The ARPACK++ reference guide is currently not part of this project (but it takes up 117 of the 195 pages of the original document). Here are some considerations (for not converting it to LaTeX):

• Pro: The ARPACK++ API is easy to use and there's an extensive list of well written examples.
• Pro: The original ARPACK++ reference guide is hard to read and it's hard to find information, if you're looking for something specific. So converting would also mean to re-structure and re-format it.
• Pro: Writing a well-formatted reference guide in LaTeX in general might be hard.
• Con: There's lots of useful information in the original reference guide.

Another approach could be to put the documentation right in the header files:

• Pro: That's probably where it belongs.
• Pro: One could use doxygen (or the like) to generate other formats.
• Con: Though the code documentation is very sparse, it's enough (imho) and putting all the information in there might harm readability.