Conversation
|
theres no documentation in source and i dont really plan on writing any. do you think documentation would add much anyhow? i dont know if having descriptions on classes and functions would really help |
Eh it really depends, in this case I think it's not always clear what the responsibility of certain classes is. Some people can figure it out from a skim read more easily than others, of course. Needless to say, this shouldn't be a priority, but it doesn't hurt to have a Doxyfile hanging around, in case you ever feel like documenting anything anyday. Besides, even a basic stub Doxygen index is good for finding classes & other top-level things at a quick glance all in one place. |
|
trueeeeeee. ill figure out how it works locally and merge probably |
|
neat! ^^ |
Co-authored-by: ouwou <26526779+ouwou@users.noreply.github.com>
This is a good first step towards generating documentation, which will help guide new contributors like myself in the future.