Documentation #162
Merged
Documentation #162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- First shot at using XML documentaiton to generate coherent and user-friendly documentation
- Improve ConfigureAnalogIO.Process documentation - Use standard enum documentation practices
- Intial docs for all headstage-64 associated classes except for TS4231DataFrame because I have a feeling that will change per #152
- Add missing </remarks> end tag
- Fix out of order xml docs tags
- Change to "Gets or sets" - Fix wording around instances of objects/classes - Removed "buffered" for brevity - Added context for underlying Mat data types - Added context for BufferSize property
- Initial breakout board and related class documentation - AnalogIO and related were exlcuded because they were addressed in #142
This was referenced Jul 25, 2024
Closed
- Added missing </remarks> tags - Fixed broken links to MangedFrame -> DataFrame
- More useful description of that TS4231 device actually is
- There are some non-existant crefs that will be solved in the near future
- Remove unnecessary includes - Remove reudandant Queue in TS4231V1PulseQueue
|
@bparks13 issue-167 has been pushed |
- And other minor things
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims to add XML tags to all public classes / methods / properties to aid in documentation.
Fixes #141
Fixes #144
Fixes #148
Fixes #157
Fixes #158
Fixes #107
Fixes #167