`tools.h` vector object commenting

redeclipse / base

Base environment for Red Eclipse and associated source files.

https://redeclipse.net/

431 stars 88 forks source link

`tools.h` vector object commenting #1394

Closed no-lex closed 1 year ago

no-lex commented 1 year ago

Changes proposed in this request:

Documents the member functions in vector<class T> that are common to Libprimis' former implementation.

The Imprimis project no longer has any use for the vector documentation it had written, since it has been replaced with std::vector in all instances. Because of this, many entries describe comparisons to std::vector.

All of the comments are in Doxygen format.

qreeves commented 1 year ago

I really appreciate the effort and helpful intentions here, but the internal discussion has resulted in the decision to retain readable code over verbose commenting as per Cube 2 style guidelines. Doxygen comments on every member of a class is just too much.

I hope Imprimis is going well and that you're flourishing in an environment with less constraints on what you can do and accomplish. Let me know if you ever need anything.