Skip to content

Documentation #29

@Ragora

Description

@Ragora

I recognize that is an early WIP but the in-code documentation is extremely lacking. There are a good handful of methods that are concisely named and there is a small tagline (more or less) describing it, but then it fails to describe other aspects of the function. A good example would be updateThreadStackSize in pThreadContinual.cpp: https://github.com/PhantomGamesDevelopment/Galactic-2D/blob/development/Source/EngineCore/Thread/pThreadContinual.h#L91

Why is it protected? Exactly why is it virtual? What exactly is the purpose of the newSize parameter in the default implementation (especially since it is just passed in by-value, assigned to and returned)?

Doxygen style comments are both easily Human readable and would allow you to generate clean HTML documentation from them. EasyDelegate is a good example:
https://github.com/Ragora/EasyDelegate/tree/188e57becfeadc75733717aa2acdfe844a04c298/include

And the accompanying web page: http://ragora.github.io/EasyDelegate/

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions