added documentations for getAmp, getType,getFreq,getPan#420
Merged
endurance21 merged 2 commits intoprocessing:masterfrom Jun 2, 2020
Merged
added documentations for getAmp, getType,getFreq,getPan#420endurance21 merged 2 commits intoprocessing:masterfrom
endurance21 merged 2 commits intoprocessing:masterfrom
Conversation
Collaborator
Author
|
@therewasaguy i have added documentations, please see if something needs to be added or so! |
Member
therewasaguy
left a comment
therewasaguy
left a comment
There was a problem hiding this comment.
thanks for the PR, and for taking the initiative to add this documentation! I've commented with some suggestions to further improve the documentation.
| * | ||
| * @method getType | ||
| * @for p5.Oscillator | ||
| * @param {String} type 'sine', 'triangle', 'sawtooth' or 'square'. |
Member
There was a problem hiding this comment.
I think you meant @returns? This method doesn't accept a @param but those are the possible return values
Collaborator
Author
There was a problem hiding this comment.
ya ! there must be returns intead of params!
i will be correcting it .
sorry for that 😅
Collaborator
Author
|
@therewasaguy |
therewasaguy
requested changes
Mar 24, 2020
endurance21
commented
Mar 24, 2020
Collaborator
Author
endurance21
left a comment
endurance21
left a comment
There was a problem hiding this comment.
done the required changes
| * | ||
| * @method getType | ||
| * @for p5.Oscillator | ||
| * @param {String} type 'sine', 'triangle', 'sawtooth' or 'square'. |
Collaborator
Author
There was a problem hiding this comment.
ya ! there must be returns intead of params!
i will be correcting it .
sorry for that 😅
therewasaguy
approved these changes
Jun 1, 2020
Member
therewasaguy
left a comment
therewasaguy
left a comment
There was a problem hiding this comment.
looks good just resolve merge conflicts and then merge please 🚢
therewasaguy
added a commit
to processing/p5.js
that referenced
this pull request
May 26, 2021
* Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606 * Fix function name in documentation processing/p5.js-sound#603 * Fix repeat initialization of audioWorklet processing/p5.js-sound#593 * Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543 * Fallback when AudioWorklet buffer array length is zero processing/p5.js-sound#542 * Remove extra callbacks for SoundFile cue processing/p5.js-sound#449 * Fix abnormal behaviour of audio output in p5.signal example section processing/p5.js-sound#476 * Fix error while playing sound through `p5.soundFile.play()` method processing/p5.js-sound#542 * Library is re-written in ESM ( ECMASCRIPT MODULES). * Audio Nodes are written as `Class` style rather than being written as `function` style. * Library using features of es6 like `let` , `const` keywords and many other es6+ features. * Testing architecture has been made more clean and robust. * All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp). * Improvements in pre-commit-hook action processing/p5.js-sound#574 * Fixed broken anchor tags in p5.Audioln processing/p5.js-sound#450 * Fixed typo in p5.fft documentation processing/p5.js-sound#433 * Added documentations for P5.oscillator APIs processing/p5.js-sound#420 * Improved documentation of p5.soundloop processing/p5.js-sound#437 * Fixed broken links in p5.panner3D documentations processing/p5.js-sound#465 * Typo improvements in p5.soundloop reference processing/p5.js-sound#557 * renames: outputVolume method and Main class processing/p5.js-sound#610 We have deprecated functionality in an effort to focus the API * p5.Signal * p5.SoundFile.processPeaks
therewasaguy
added a commit
to processing/p5.js
that referenced
this pull request
May 26, 2021
Bug Fixes * Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606 * Fix function name in documentation processing/p5.js-sound#603 * Fix repeat initialization of audioWorklet processing/p5.js-sound#593 * Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543 * Fallback when AudioWorklet buffer array length is zero processing/p5.js-sound#542 * Remove extra callbacks for SoundFile cue processing/p5.js-sound#449 * Fix abnormal behaviour of audio output in p5.signal example section processing/p5.js-sound#476 * Fix error while playing sound through `p5.soundFile.play()` method processing/p5.js-sound#542 Intrastructure Improvements * Library is re-written in ESM ( ECMASCRIPT MODULES). * Audio Nodes are written as `Class` style rather than being written as `function` style. * Library using features of es6 like `let` , `const` keywords and many other es6+ features. * Testing architecture has been made more clean and robust. * All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp). * Improvements in pre-commit-hook action processing/p5.js-sound#574 Documentation Fixes * Fixed broken anchor tags in p5.Audioln processing/p5.js-sound#450 * Fixed typo in p5.fft documentation processing/p5.js-sound#433 * Added documentations for P5.oscillator APIs processing/p5.js-sound#420 * Improved documentation of p5.soundloop processing/p5.js-sound#437 * Fixed broken links in p5.panner3D documentations processing/p5.js-sound#465 * Typo improvements in p5.soundloop reference processing/p5.js-sound#557 Deprecations and Renames * renames: outputVolume method and Main class processing/p5.js-sound#610 * We have deprecated functionality in an effort to focus the API * p5.Signal * p5.SoundFile.processPeaks
3 tasks
therewasaguy
added a commit
to processing/p5.js
that referenced
this pull request
May 26, 2021
Bug Fixes * Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606 * Fix function name in documentation processing/p5.js-sound#603 * Fix repeat initialization of audioWorklet processing/p5.js-sound#593 * Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543 * Fallback when AudioWorklet buffer array length is zero processing/p5.js-sound#542 * Remove extra callbacks for SoundFile cue processing/p5.js-sound#449 * Fix abnormal behaviour of audio output in p5.signal example section processing/p5.js-sound#476 * Fix error while playing sound through `p5.soundFile.play()` method processing/p5.js-sound#542 * Bring back p5.PeakDetect which was missing in 1.0.0 Intrastructure Improvements * Library is re-written in ESM ( ECMASCRIPT MODULES). * Audio Nodes are written as `Class` style rather than being written as `function` style. * Library using features of es6 like `let` , `const` keywords and many other es6+ features. * Testing architecture has been made more clean and robust. * All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp). * Improvements in pre-commit-hook action processing/p5.js-sound#574 Documentation Fixes * Fixed broken anchor tags in p5.Audioln processing/p5.js-sound#450 * Fixed typo in p5.fft documentation processing/p5.js-sound#433 * Added documentations for P5.oscillator APIs processing/p5.js-sound#420 * Improved documentation of p5.soundloop processing/p5.js-sound#437 * Fixed broken links in p5.panner3D documentations processing/p5.js-sound#465 * Typo improvements in p5.soundloop reference processing/p5.js-sound#557 Deprecations and Renames * renames: outputVolume method and Main class processing/p5.js-sound#610 * We have deprecated functionality in an effort to focus the API * p5.Signal * p5.SoundFile.processPeaks
therewasaguy
added a commit
to processing/p5.js
that referenced
this pull request
May 30, 2021
Bug Fixes * Fix drywet function bug https://github.com/processing/p5.js-sound/pulls/606 * Fix function name in documentation processing/p5.js-sound#603 * Fix repeat initialization of audioWorklet processing/p5.js-sound#593 * Fix issue with p5.Score that prevented parts from being passed as argument processing/p5.js-sound#543 * Fallback when AudioWorklet buffer array length is zero processing/p5.js-sound#542 * Remove extra callbacks for SoundFile cue processing/p5.js-sound#449 * Fix abnormal behaviour of audio output in p5.signal example section processing/p5.js-sound#476 * Fix error while playing sound through `p5.soundFile.play()` method processing/p5.js-sound#542 * Bring back p5.PeakDetect which was missing in 1.0.0 Intrastructure Improvements * Library is re-written in ESM ( ECMASCRIPT MODULES). * Audio Nodes are written as `Class` style rather than being written as `function` style. * Library using features of es6 like `let` , `const` keywords and many other es6+ features. * Testing architecture has been made more clean and robust. * All above listed improvements are part of [Divyanshu's](https://github.com/endurance21) GSOC-20 Project , more details can be found in his [wrap-up-post](https://github.com/endurance21/GSOC-20-WrapUp). * Improvements in pre-commit-hook action processing/p5.js-sound#574 Documentation Fixes * Fixed broken anchor tags in p5.Audioln processing/p5.js-sound#450 * Fixed typo in p5.fft documentation processing/p5.js-sound#433 * Added documentations for P5.oscillator APIs processing/p5.js-sound#420 * Improved documentation of p5.soundloop processing/p5.js-sound#437 * Fixed broken links in p5.panner3D documentations processing/p5.js-sound#465 * Typo improvements in p5.soundloop reference processing/p5.js-sound#557 Deprecations and Renames * renames: outputVolume method and Main class processing/p5.js-sound#610 * We have deprecated functionality in an effort to focus the API * p5.Signal * p5.SoundFile.processPeaks
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
2 participants
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.
solves the issue
#411
added documentations for required METHODS
areas of impact
src/oscillator.js