JSDoc in Get Started Section

[Sarfraz-droid]

Checklist

Issue : #3725

• run npm run test and npm run benchmark
• tests and/or benchmarks are included
• documentation is changed or added
• commit message and code follows the Developer's Certification of Origin
  and the Code of conduct

[climba03003]

Please provide a short description for the JSDoc param and function.
e.g. what is it? document reference?

[Sarfraz-droid]

Please provide a short description for the JSDoc param and function. e.g. what is it? document reference?

Where should I provide? on top file or everywhere it is used?

[climba03003]

Please provide a short description for the JSDoc param and function. e.g. what is it? document reference?

Where should I provide? on top file or everywhere it is used?

For example

/**
 * a plugin that provide encapsulated routes
 * @param {FastifyInstance} fastify encapsulated fastify instance
 * @param {Object} options plugin options, may refer to https://www.fastify.io/docs/latest/Reference/Plugins/#plugin-options
 * */
async function routes (fastify, options) {

[Fdawgs]

This does not resolve #3725. @RafaelGSS was talking about @type jsdoc tags: #3725 (comment)

[Sarfraz-droid]

@Fdawgs What typename should i attach to ?

const fastify = Fastify({
  logger: true
})

[Sarfraz-droid]

@climba03003 can you have a look the changes? I have added short descriptions for JSDoc

[Fdawgs]

Suggested change

	* */
	*/

[RafaelGSS]

LGTM.

[3imed-jaberi]

+1 ✅

[mcollina]

lgtm

[Fdawgs]

@climba03003 mind re-reviewing when you get a sec, please?

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.