]> git.corax.cc Git - toolbox/commit
docs: Add module reference
authorMatthias Kruk <m@m10k.eu>
Sun, 9 Oct 2022 04:22:47 +0000 (13:22 +0900)
committerMatthias Kruk <m@m10k.eu>
Sun, 1 Jan 2023 06:18:25 +0000 (15:18 +0900)
commit99173d4ce7be3311c3bb3261e17d92e3e68f28f4
tree3e7369248663568a8d7a399a9bff8838d51328b1
parent8c0e34e3a2d10812b8d38d4ea1ebcf3eb7a14ab8
docs: Add module reference

None of the modules and functions in toolbox are documented. Thus,
users have to read the source code to understand how functions work,
and to find out what functions are there to begin with.

This commit adds a module reference, documenting modules and the
functions that they implement. The following modules are documented
in the reference:

 - array
 - conf
 - mutex
 - wmutex
 - git
 - inst
 - queue
 - opt
 - is
 - sem
 - json
 - log
14 files changed:
README.md
docs/array.md [new file with mode: 0644]
docs/conf.md [new file with mode: 0644]
docs/git.md [new file with mode: 0644]
docs/inst.md [new file with mode: 0644]
docs/is.md [new file with mode: 0644]
docs/json.md [new file with mode: 0644]
docs/log.md [new file with mode: 0644]
docs/mutex.md [new file with mode: 0644]
docs/opt.md [new file with mode: 0644]
docs/queue.md [new file with mode: 0644]
docs/reference.md [new file with mode: 0644]
docs/sem.md [new file with mode: 0644]
docs/wmutex.md [new file with mode: 0644]