Alphish / gm-community-toolbox

A collection of utility functions for GameMaker.
MIT License
34 stars 6 forks source link

ISS-58: Implement docs generator and fill the reference for functions so far #61

Closed Alphish closed 3 months ago

Alphish commented 9 months ago

This PR will eventually address issue #58 for documenting the Community Toolbox functionality so far.

I wrote a "Docs Generator" project which:

You can preview the generated reference on the feature branch here. Note that most functions don't have reference stubs written for them, so they don't appear yet. Likewise, the reference main page, as well as scripts and region pages might be a bit lackluster at the moment.

Since not all documentation is written yet, this PR is a draft so far. At the moment, I'm mostly waiting for feedback about whether the general docs generation mechanics look good and if there are some additional features people would like to include in reference pages (like "Go to source" link already added to function pages).

Mercerenies commented 3 months ago

A few minor notes:

Alphish commented 3 months ago

@Mercerenies All of the points mentioned should be fixed now.