August 2021
Posted 3 years ago
I've got a wiki bot that looks at the s&box dlls and adds documentation pages for all of the public classes etc.

This bot was pretty basic and we only had a few pages filled out, so I went in this month and made some improvements and got a bunch more done.

The funny thing about documenting an API is that you end up seeing a bunch of bullshit in the design that you wouldn't otherwise see. I think this is a really good reason why the developers themselves should be documenting stuff like this, because they're more likely to fix the code rather than document it anyway.

This stuff still isn't perfect, like it's missing information indicating that a class has a base class, which I think would be useful. Attributes create a bunch of junk. And really I think the design could be more intuitive and useful.