2278bb0dfa
1. All stuff to generate documentation is moved from 'gen_iface.py' to a separate module 'gen_docs.py'. It contains several new structures to support maintenance of the documentation: categoriesList - A list of the categories and an optional description. docsMap - A dictionary that assigns each method to one of the categories. docOverrides - A dictionary that can be used to replace the docstring from the iface file. docSubstitutions - A dictionary that can be used to replace a few words from the docstring in the iface file. extendedDocs - A dictionary that can be used to add extended documentation. sinceAnnotations - A dictionary that can be used to add '@since' annotations. 2. Documentation is reformatted and updated: - Added a table of contents. - Broke the methods into sections. - Added docs for previously undocumented methods. - Altered docs that were unhelpful or misleading. - Added '@since 3.1.0' notes and '@since 3.1.1' notes. - Altered docs which contained references to Scintilla macros or other problematic text. Closes #17680. |
||
---|---|---|
.. | ||
private.h | ||
stc.h |