Documentation of p5.Oscillator is incomplete

[JimBrink]

processing/p5.js#3815 ## Most appropriate sub-area of p5.js?

• [ x] Other (specify if possible) sound library

Details about the bug:

The documentation for p5.Oscillator is missing some existing trivial methods that may be useful. Unfortunately, potential users normally can't use them if they do not know they exist. getFreq() getAmp() getType() getPan()

[endurance21]

@therewasaguy can you please guide me , how i can get started to add documentations?

[therewasaguy]

@endurance21 thanks for your interest! Here's a guide to getting started with documentation: https://github.com/processing/p5.js-sound/wiki/Documentation If anything is unclear, you can update the documentation along the way, and/or ask questions to help clarify.

Essentially you can add documentation by adding JSDoc-style documentation to this file, for example https://github.com/processing/p5.js-sound/blob/master/src/oscillator.js#L11

[parulpriyedarshani]

@therewasaguy The p5.js Documentation guide link for writing the documentation is giving the 404 error as the Page cannot be found. Could you please help me out with this?

[therewasaguy]

thank you, @parulpriyedarshani, and apologies for the delayed response but I've just updated the link in the wiki, and this is the link: https://github.com/processing/p5.js/blob/main/contributor_docs/inline_documentation.md

[parulpriyedarshani]

@therewasaguy thank you! That was really helpful.