search

oakmound / oak

A pure Go game engine
Apache License 2.0
1.52k stars 84 forks source link

Doc + refactor pass 1 #204

Closed 200sc closed 2 years ago

200sc commented 2 years ago

This was intended as a documentation + tests pass. It turned into a documentation + refactor as things are documented pass. It covers the top and bottom packages of the repository, oak, window up through scene and alg and audio.

Open questions:

  1. Should we re-add Window.Width() and Window.Height() for convenience?
codecov-commenter commented 2 years ago

Codecov Report

Merging #204 (121dabc) into release/v4.0.0 (21c4487) will increase coverage by 4.19%. The diff coverage is 97.09%.

@@                Coverage Diff                 @@
##           release/v4.0.0     #204      +/-   ##
==================================================
+ Coverage           90.82%   95.01%   +4.19%     
==================================================
  Files                 138      143       +5     
  Lines                6255     6344      +89     
==================================================
+ Hits                 5681     6028     +347     
+ Misses                515      285     -230     
+ Partials               59       31      -28
Impacted Files Coverage Δ
alg/floatgeom/point.go 100.00% <ø> (ø)
alg/floatgeom/polygon.go 98.14% <ø> (ø)
alg/intgeom/point.go 100.00% <ø> (ø)
collision/attachSpace.go 100.00% <ø> (ø)
collision/filter.go 100.00% <ø> (ø)
collision/geom.go 100.00% <ø> (ø)
collision/onCollision.go 93.93% <ø> (ø)
collision/point.go 100.00% <ø> (ø)
collision/ray/castFilter.go 97.05% <ø> (ø)
collision/ray/castLimit.go 100.00% <ø> (ø)
... and 115 more

:mega: Codecov can now indicate which changes are the most critical in Pull Requests. Learn more