KierannCode / Playground

Project about creating a game engine with SDL from scratch, this is for fun and for my personal experience only
0 stars 0 forks source link

Adding initial documentation #4

Open KierannCode opened 2 years ago

KierannCode commented 2 years ago

The code is currently totally undocumented

A documentation must be created for every header file (.hpp) and template file. Starting with Object SDL (OSDL) implementations. Every progress in the documentation will be recorded here, committed in the documentation branch.

Once the initial documentation will be over, each new implementation shall have it's documentation set before any commit. Hence, this should be the only issue about documentation

KierannCode commented 2 years ago

Added documentation for the class OSDL::Mutex

KierannCode commented 2 years ago

Major update : -Added Documentation generation using Doxygen plug-in for eclipse (*.doxyfiles in new folder Documentation) -README added, it includes the url allowing access to the documentation of OSDL and the playground API. -Created gh-pages branch to access the documentation. ⚠️TODO⚠️ : An important warning must be added somewhere : gh-pages is NOT a working branch, its only purpose is to update the html documentation generated by Doxygen. Merging from this branch is forbidden

Minor updates : -Intermediate Software folder added to exclude implemented software from the documentation (which are only here to enhance and test the Playground API) -Added @brief and @details tag to OSDL::Mutex documentation

A global merge has been done to synchronize branches master and documentation.

KierannCode commented 2 years ago

Added full documentation for interface OSDL::Data. Updated documentation consistency and OSDL::Mutex documentation Updated online OSDL documentation

KierannCode commented 2 years ago

Added full documentation for OSDL::AtomicBoolean Updated documentation consistency (dot character at the end of every line) Moved two exception classes into sub-folders

KierannCode commented 2 years ago

Added full documentation for OSDL::AtomicQueue Improved global consistency : -Sentences ends with a dot character only in the details sections. -The class itself must not be mentioned in its members documentation (in order to reduce redundancy)

Simplified header guards. Subsequent headers guards are defined with the project acronym, underscore, file/class name.

KierannCode commented 2 years ago

Removed private members documentation in doxygen files (gh-pages branch)

KierannCode commented 2 years ago

Added full CoreThread documentation Documentation generation has been modified : -undocumented declarations will be ignored -private members documentation will be generated if present (useful when implementing virtual private members)

New convention for the project : it is forbidden to throw an exception from a destructor but logging is allowed, hence the documentation must mention this feature if necessary