abaddon icon indicating copy to clipboard operation
abaddon copied to clipboard

Setup Doxyfile

Open wallabra opened this issue 1 year ago • 4 comments

This is a good first step towards generating documentation, which will help guide new contributors like myself in the future.

wallabra avatar May 21 '24 16:05 wallabra

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

ouwou avatar Jun 02 '24 08:06 ouwou

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.

wallabra avatar Jun 09 '24 05:06 wallabra

trueeeeeee. ill figure out how it works locally and merge probably

ouwou avatar Jun 13 '24 01:06 ouwou

neat! ^^

wallabra avatar Jun 14 '24 22:06 wallabra