Add API template#9
Draft
banchan86 wants to merge 29 commits into
Draft
Conversation
From open-ephys/bonsai-onix1-docs@c2e0bd4 Co-authored-by: Cris <cs@open-ephys.org> Co-authored-by: Brandon Parks <bap@open-ephys.org>
- The original template has code that enables display of enums values and description on some of the classes that use them - Some of it seems to be specific to OE nodes, but I have kept the one in the defineProperties function that applies generally
- Not sure what that section was doing but removing it didnt change anything, so it was probably OE specific
This reverts commit 428370d.
- Final version of OE template that retains all the features we want to port over - From here on out I am adding new features
- Adds namespace and definitions - Add inheritance, implements, and derived classes, but leaves out inherited members
Co-authored-by: Cris <cs@open-ephys.org>
- replaceIObservableAndTSource edited to fit new refactored functions - sortProperties and defineEnumFields refactored Co-authored-by: Cris <cs@open-ephys.org>
Co-authored-by: Cris <cs@open-ephys.org> Co-authored-by: Brandon Parks <bap@open-ephys.org>
This was referenced Nov 16, 2024
Author
|
Converting to draft to work on feedback from DCM. |
Author
|
On hold as there are significant problems with this approach, especially in pulling information from external types (like Bonsai packages or Bonsai Core). Goncalo is exploring alternative solutions for docfx in general by going through the C# plugin route. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Resolves #8.
Based off @cjsha and @bparks13 template for https://open-ephys.github.io/bonsai-onix1-docs/index.html
See Readme for usage instructions.
Might have a merge conflict with #7, because the way I started out with those 2 branches was by deleting files from each. But basically keep all the files that are present.
Original unmodified docs: https://bonsai-rx.org/pulsepal/api/Bonsai.PulsePal.ConfigureOutputChannel.html
Online preview of this PR: https://banchan86.github.io/pulsepal_docs_rev/api/Bonsai.PulsePal.ConfigureOutputChannel.html