Commit 0a9c707f authored by Robert Knight's avatar Robert Knight

Replace '@p <ident>' with `ident` in JSDoc comments

Using '@p <ident>' to refer to parameters in JSDoc comments is not legal
syntax. Use Markdown backticks instead, ala. Angular's docs.
parent 18198d1f
...@@ -34,7 +34,7 @@ var LinkType = { ...@@ -34,7 +34,7 @@ var LinkType = {
* @param {EditorState} state - The state of the input field. * @param {EditorState} state - The state of the input field.
* @param {number} pos - The start position of the text to remove. * @param {number} pos - The start position of the text to remove.
* @param {number} length - The number of characters to remove. * @param {number} length - The number of characters to remove.
* @param {string} text - The replacement text to insert at @p pos. * @param {string} text - The replacement text to insert at `pos`.
* @return {EditorState} - The new state of the input field. * @return {EditorState} - The new state of the input field.
*/ */
function replaceText(state, pos, length, text) { function replaceText(state, pos, length, text) {
......
...@@ -46,7 +46,7 @@ function convertLocalURLsToFilenames(url) { ...@@ -46,7 +46,7 @@ function convertLocalURLsToFilenames(url) {
} }
/** /**
* Return a transformed version of @p data with local URLs replaced * Return a transformed version of `data` with local URLs replaced
* with filenames. * with filenames.
* *
* In environments where the client is served from a local URL, * In environments where the client is served from a local URL,
......
...@@ -103,7 +103,7 @@ module.exports = function WidgetController( ...@@ -103,7 +103,7 @@ module.exports = function WidgetController(
} }
/** /**
* Load annotations for all URLs associated with @p frames. * Load annotations for all URLs associated with `frames`.
* *
* @param {Array<{uri:string}>} frames - Hypothesis client frames * @param {Array<{uri:string}>} frames - Hypothesis client frames
* to load annotations for. * to load annotations for.
......
...@@ -87,7 +87,7 @@ function uploadReleaseFile(opts, project, release, file) { ...@@ -87,7 +87,7 @@ function uploadReleaseFile(opts, project, release, file) {
* Upload a stream of Vinyl files as a Sentry release. * Upload a stream of Vinyl files as a Sentry release.
* *
* This creates a new release in Sentry using the organization, project * This creates a new release in Sentry using the organization, project
* and release settings in @p opts and uploads the input stream of Vinyl * and release settings in `opts` and uploads the input stream of Vinyl
* files as artefacts for the release. * files as artefacts for the release.
* *
* @param {SentryOptions} opts * @param {SentryOptions} opts
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment