Skip to content
This repository has been archived by the owner on Sep 4, 2024. It is now read-only.

Document device kit camera header #27

Closed
andy-sweet opened this issue Aug 22, 2023 · 0 comments · Fixed by #35
Closed

Document device kit camera header #27

andy-sweet opened this issue Aug 22, 2023 · 0 comments · Fixed by #35
Assignees
@andy-sweet
Labels
documentation Improvements or additions to documentation

Comments

@andy-sweet
Copy link
Contributor

Currently camera.h in the device kit contains almost no documentation.

While writing a new camera driver (spinnaker), I would have found it useful to understand the intended semantics and (non-)expected side effects of the member functions of the Camera struct, so that I could provide suitable implementations.

This task is done when the camera header file contains enough descriptive comments to clarify those expectations.
@andy-sweet andy-sweet added the documentation Improvements or additions to documentation label Aug 22, 2023
@andy-sweet andy-sweet self-assigned this Sep 6, 2023
@andy-sweet andy-sweet mentioned this issue Sep 27, 2023
Merged
nclack pushed a commit that referenced this issue Dec 14, 2023
@andy-sweet
Add descriptive comments to camera device and properties headers (#35)
f2dd747 
This adds some missing header doc comments and updates other to clarify
what some struct members are more exactly.

Closes #27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@andy-sweet andy-sweet

Labels
documentation Improvements or additions to documentation
Projects
Image Acquisition Team Board
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add descriptive comments to camera device and properties headers andy-sweet/acquire-core-libs
1 participant
@andy-sweet