Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API template #9

Open
wants to merge 29 commits into
base: main
Choose a base branch
from
Open

Add API template #9

wants to merge 29 commits into from

Conversation

banchan86
Copy link

@banchan86 banchan86 commented Aug 22, 2024

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

banchan86 and others added 29 commits August 8, 2024 14:18
- 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
- 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
- replaceIObservableAndTSource edited to fit new refactored functions
- sortProperties and defineEnumFields refactored

Co-authored-by: Cris <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Custom API template to improve documentation user-friendliness
1 participant