Commit Graph

17 Commits

Author SHA1 Message Date
K. Lange
ff23dbbc14 Update docs 2022-07-09 08:12:31 +09:00
K. Lange
07e04b001c Scan new src/modules/ directory for Doxygen stuff 2021-04-28 21:26:44 +09:00
K. Lange
ceb8c59988 Write some docs on binding C functions 2021-04-19 08:45:02 +09:00
K. Lange
bc27feca69 Sporadic doc improvements 2021-04-17 17:33:45 +09:00
HarJIT
614193b8a1
Codecs package docs, as well as some assorted tweaks or minor additions (#5)
* Add some docs, and remove second Code page 874 codec (they handled the
non-overridden C1 area differently, but we only need one).

* More docs work.

* Doc stuff.

* Adjusted.

* More tweaks (table padding is not the docstring's problem).

* CSS and docstring tweaks.

* Link from modules to parent packages and vice versa.

* More documentation.

* Docstrings for all `codecs` submodules.

* Move encode_jis7_reduced into dbextra_data_7bit (thus completing the lazy
startup which was apparently not complete already) and docstrings added to
implementations of base class methods referring up to the base class.

* Remove FUSE junk that somehow made it into the repo.

* Some more docstrings.

* Fix some broken references to `string` (rather than `data`) which would have
caused a problem if any existing error handler had returned a negative
offset (which no current handler does, but it's worth fixing anyway).

* Add a cp042 codec to accompany the x-user-defined codec, and to pave the
way for maybe adding Adobe Symbol, Zapf Dingbats or Wingdings codecs
in future.

* Better Japanese Autodetect behaviour for ISO-2022-JP (add yet another
condition in which it will be detected, making it able to conclusively
detect it prior to end of stream without being fed an entire escape
sequence in one call). Also some docs tweaks.

* idstr() → _idstr() since it's internal.

* Docs for codecs.pifonts.

* Docstrings for dbextra.

* Document the sbextra classes.

* Docstrings for the web encodings.

* Possibly a fairer assessment of likely reality.

* Docstrings for codecs.binascii

* The *encoding* isn't removed (the BOM is).

* Make it clearer when competing OEM code pages use different letter layouts.

* Fix copied in error.

* Stop generating linking to non-existent "← tools" from tools.gendoc.

* Move .fuse_hidden* exclusion to my user-level config.

* Constrain the table style changes to class .markdownTable, to avoid any
effect on other interface tables generated by Doxygen.

* Refer to `__ispackage__` when generating help.
2021-04-02 16:34:10 +09:00
K Lange
551b5d8f2e Add cloc language definition file 2021-03-26 22:47:54 +09:00
K. Lange
9659be93ba Teach Doxygen KRK_METHOD, KRK_FUNC 2021-03-25 15:52:54 +09:00
K. Lange
50f94d9d3b Update doc generation for properties, type hints 2021-03-25 09:54:07 +09:00
K. Lange
bdf1e9b492 Fix docs build for headers 2021-03-22 10:02:48 +09:00
K. Lange
5ce03ebcf5 (docs) change header link for generated doc pages 2021-02-28 23:04:36 +09:00
K. Lange
bc856ac063 Ongoing documentation improvements 2021-02-25 08:50:37 +09:00
K. Lange
617c1e8eec Add docs/syntax.md just to have the page exist 2021-02-23 13:00:47 +09:00
K. Lange
5c8126d65d Add a pseudo-grammar in EBNF? It's not necessarily accurate, but it's close enough to be a useful reference 2021-02-23 07:38:37 +09:00
K. Lange
4235c74138 Generate indexes, fixup CSS for mobile 2021-02-20 22:32:11 +09:00
K. Lange
a5ff538dc1 Write a bunch more docs 2021-02-20 20:44:07 +09:00
K. Lange
76d53eb198 Various doc improvements 2021-02-20 15:43:47 +09:00
K. Lange
d5d3d721e7 The big documentation system overhaul 2021-02-20 14:10:36 +09:00