Skip to content

Setup Doxyfile#301

Open
wallabra wants to merge 3 commits intouowuo:masterfrom
wallabra:topic/doxygen
Open

Setup Doxyfile#301
wallabra wants to merge 3 commits intouowuo:masterfrom
wallabra:topic/doxygen

Conversation

@wallabra
Copy link
Contributor

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

@ouwou
Copy link
Member

ouwou commented Jun 2, 2024

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

@wallabra
Copy link
Contributor Author

wallabra commented Jun 9, 2024

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.

@ouwou
Copy link
Member

ouwou commented Jun 13, 2024

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

@wallabra
Copy link
Contributor Author

neat! ^^

Co-authored-by: ouwou <26526779+ouwou@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants