1,855
edits
Project - Documentation: Difference between revisions
→Octave's internal documentation: Suggested more improvements.
(→Octave's internal documentation: Suggested improvements.) |
(→Octave's internal documentation: Suggested more improvements.) |
||
| Line 82: | Line 82: | ||
** As Octave's GUI makes use of qt, Doxygen might also be replaced by [https://doc.qt.io/qt-5/qdoc-index.html QDoc] with comparable markup. | ** As Octave's GUI makes use of qt, Doxygen might also be replaced by [https://doc.qt.io/qt-5/qdoc-index.html QDoc] with comparable markup. | ||
** Splitting the documentation into a wiki portion, etc., is imaginable, but it must be clearly documented where to find which information, '''avoid duplication''', nobody wants to update information in more than one location. | ** Splitting the documentation into a wiki portion, etc., is imaginable, but it must be clearly documented where to find which information, '''avoid duplication''', nobody wants to update information in more than one location. | ||
* Technical goals are: | |||
** Smaller memory footprint for individual documents (unlike current Doxygen with about 2 GB). | |||
** Fast build time. | |||
** Lightweight (existing) documentation system. No heavy preprocessing / code generation by custom scripts. | |||
** As close to the source as necessary. Make it difficult to update the code while not updating it's documentation. E.g. no wiki documentation for Octave's C++ files. | |||
'''Resources''' | '''Resources''' | ||