STORM-IRIT / Radium-Engine

Research 3D Engine for rendering, animation and processing
https://storm-irit.github.io/Radium-Engine/
Apache License 2.0
100 stars 50 forks source link

[core] Add doxygen doc for Math namespace. #1030

Closed dlyr closed 1 year ago

dlyr commented 1 year ago

currently, function in math namespace are not documented. this is due to the fact that math namespace misses documentation.

this PR adds a small doc to math namespace such that every documented function in math namespace get their documentation available in doxygen

before Screenshot from 2022-12-13 19-42-45 after Screenshot from 2022-12-13 19-41-58

Screenshot from 2022-12-13 19-42-16

codecov[bot] commented 1 year ago

Codecov Report

Merging #1030 (313161b) into release-candidate (84abbcd) will not change coverage. The diff coverage is n/a.

@@                Coverage Diff                 @@
##           release-candidate    #1030   +/-   ##
==================================================
  Coverage              45.61%   45.61%           
==================================================
  Files                    343      343           
  Lines                  23100    23100           
==================================================
  Hits                   10536    10536           
  Misses                 12564    12564           
Impacted Files Coverage Δ
src/Core/Math/Math.hpp 100.00% <ø> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

nmellado commented 1 year ago

We wait for version update before merging.