Incomplete API documentation

justinethier / cyclone

:cyclone: A brand-new compiler that allows practical application development using R7RS Scheme. We provide modern features and a stable system capable of generating fast native binaries.

http://justinethier.github.io/cyclone/

MIT License

823 stars 42 forks source link

Incomplete API documentation #454

Open justinethier opened 3 years ago

justinethier commented 3 years ago

Noting the following areas of our API docs that are incomplete:

~~SRFI 106 (sockets) - The library contents are listed but not documented further~~
~~SRFI 117 (queues) - Contents are not documented~~
~~SRFI 128 (comparators) - Contents are not documented~~
~~SRFI 132 (sort) - Contents are not documented~~
~~SRFI 133 (vectors) - Wrong name, and contents are not documented~~
~~(cyclone test) - Contents are not documented~~
Internal (scheme cyclone) library docs are spotty. At a minimum we need to note which libraries here do not have stable API's (most, in theory) and document the important functions

~~In addition it would be helpful if Github actions could be used to autogenerate the Doxygen content for the C API, though that is a "nice to have".~~

justinethier commented 3 years ago

The remaining internal libraries to document are:

(scheme cyclone cps-optimizations)
(scheme cyclone transforms)
(scheme cyclone util)

Of those util is probably the most important.

Each of these will take some work but it could be helpful to document all three. Both to improve understanding of the code (now and in the future) as well as to potentially help clean up cruft in these modules.