search

Freedom-of-Form-Foundation / anatomy3d

A CAD tool for humanoid anatomy alterations. See the anatomy3d-blender repository for more recent work.
https://freedomofform.org/1856/3d-anatomy-project-scope-phase-1-focus-on-a-limb-joint/
GNU General Public License v2.0
7 stars 5 forks source link

Add class comments #8

Closed AdamNorberg closed 2 years ago

AdamNorberg commented 3 years ago

Many functions in this codebase have descriptive /// <summary> ... </summary> comments, but classes seem not to. Documenting the purpose of a class makes it much easier for a new developer to get a feel for the design of this codebase.

Can brief comments describing what classes are intended to be for be added? In my opinion, it's more important for the abstract classes than the concrete ones, since the concrete classes are apparent relative to their abstract classes but I'm fuzzy on what the abstract class is intended to cover.

Lathreas commented 2 years ago

I think most if not all non-draft classes have a proper description now. Shall I close this issue?