Skip to content
This repository was archived by the owner on May 12, 2025. It is now read-only.

Add e.g. to describe an example for the value #60

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

mahdiyari
Copy link

@mahdiyari mahdiyari commented Nov 7, 2024

Append e.g. value to the end of the description to define an example value for the parameter.
This is useful for required parameters that you want to provide an example value.

/**
 * @queryParam {integer} id - The user id to search for. e.g. 20
 */

published under oa-parser on npm

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant