Work on adding more doxygen comments #12

shaunrd0 · 2022-11-25T23:03:54Z

shaunrd0 commented

2022-11-25 23:03:54 +00:00

Adds some very basic doxygen comments to explain the intended use of classes and important methods.

The comments added in this PR were intentionally minimal. I expect a lot of this code to change and I don't want to waste time documenting things I'll end up replacing. Still, I think some documentation is necessary and this adds the bare minimum.

Adds some very basic doxygen comments to explain the intended use of classes and important methods. The comments added in this PR were intentionally minimal. I expect a lot of this code to change and I don't want to waste time documenting things I'll end up replacing. Still, I think some documentation is necessary and this adds the bare minimum.

shaunrd0 added 1 commit 2022-11-25 23:03:54 +00:00

d37484d75c Work on adding more doxygen comments

shaunrd0 added 1 commit 2022-11-26 17:49:49 +00:00

7f13b2d729 Example of using new simple API

+ Clean up some TODOs
+ More docs
+ Disable clang-format in Mesh

shaunrd0 added a new dependency 2022-11-26 18:05:32 +00:00

#9 Doxygen

shaunrd0 removed a dependency 2022-11-26 18:05:47 +00:00

#9 Doxygen

shaunrd0 added 1 commit 2022-11-26 18:08:40 +00:00

fe64775bcb *

shaunrd0 force-pushed docs from fe64775bcb to c94dc50418

2022-11-26 18:09:22 +00:00

Compare

shaunrd0 merged commit a04ebae42a into master

2022-11-26 18:24:39 +00:00

shaunrd0 deleted branch docs

2022-11-26 18:24:39 +00:00

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No project

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: shaunrd0/qtk#12