docs: Format tags & variables instead of quoting

Author: Zearin

content/en/about-commandline.md

@@ -11,8 +11,8 @@ At its most basic level, JSDoc is used like so:
 
 where `...` are paths to other files to generate documentation for.
 
-Additionally, one may provide the path to a [Markdown file][md-file] (ending in ".md") or a file
-named "README", and this will be added to the documentation on the front page. See [these
+Additionally, one may provide the path to a [Markdown file][md-file] (ending in `.md`) or a file
+named `README`, and this will be added to the documentation on the front page. See [these
 instructions][including-readme].
 
 JSDoc supports a number of command-line options, many of which have both long and short forms.

content/en/about-configuring-jsdoc.md

@@ -177,7 +177,7 @@ use the [`-r` command-line option][about-commandline] to recurse into subdirecto
 this array may include subdirectories of the paths in `source.include`.
 + `source.includePattern`: An optional string, interpreted as a regular expression. If present, all
 filenames must match this regular expression to be processed by JSDoc. By default, this option is
-set to ".+\.js(doc|x)?$", meaning that only files with the extensions `.js`, `.jsdoc`, and
+set to `.+\.js(doc|x)?$`, meaning that only files with the extensions `.js`, `.jsdoc`, and
 `.jsx` will be processed.
 + `source.excludePattern`: An optional string, interpreted as a regular expression. If present, any
 file matching this regular expression will be ignored. By default, this option is set so that files

content/en/about-namepaths.md

@@ -21,7 +21,7 @@ MyConstructor~innerMember // note that JSDoc 2 uses a dash
 ```
 {% endexample %}
 
-The example below shows: an _instance_ method named "say," an _inner_ function also named "say," and a _static_ method also named "say." These are three distinct methods that all exist independently of one another.
+The example below shows: an _instance_ method named `say`, an _inner_ function also named `say`, and a _static_ method also named `say`. These are three distinct methods that all exist independently of one another.
 
 {% example "Use a documentation tag to describe your code." %}
 
@@ -58,7 +58,7 @@ Person~say  // the inner method named "say."
 ```
 {% endexample %}
 
-You might wonder why there is a syntax to refer to an inner method when that method isn't directly accessible from outside the function it is defined in. While that is true, and thus the "~" syntax is rarely used, it _is_ possible to return a reference to an inner method from another method inside that container, so it is possible that some object elsewhere in your code might borrow an inner method.
+You might wonder why there is a syntax to refer to an inner method when that method isn't directly accessible from outside the function it is defined in. While that is true, and thus the `~` syntax is rarely used, it _is_ possible to return a reference to an inner method from another method inside that container, so it is possible that some object elsewhere in your code might borrow an inner method.
 
 Note that if a constructor has an instance member that is also a constructor, you can simply chain the namepaths together to form a longer namepath:
 
@@ -81,7 +81,7 @@ i.consider();
 ```
 {% endexample %}
 
-In this case, to refer to the method named "consider," you would use the following namepath:
+In this case, to refer to the method named `consider`, you would use the following namepath:
 `Person#Idea#consider`
 
 
@@ -102,7 +102,7 @@ This chaining can be used with any combination of the connecting symbols: `# . ~
 ```
 {% endexample %}
 
-There are some special cases with namepaths: [@module][module-tag] names are prefixed by "module:", [@external][external-tag] names are prefixed by "external:", and [@event][event-tag] names are prefixed by "event:".
+There are some special cases with namepaths: [`@module`][module-tag] names are prefixed by `module:`, [`@external`][external-tag] names are prefixed by `external:`, and [`@event`][event-tag] names are prefixed by `event:`.
 
 {% example "Namepaths of objects with special characters in the name." %}
 
@@ -136,8 +136,8 @@ var chat = {
 {% endexample %}
 
 Above is an example of a namespace with "unusual" characters in its member names (the hash character, dashes, even quotes).
-To refer to these you just need quote the names: chat."#channel", chat."#channel"."op:announce-motd", and so on.
-Internal quotes in names should be escaped with backslashes: chat."#channel"."say-\"hello\"".
+To refer to these you just need quote the names: `chat."#channel"`, `chat."#channel"."op:announce-motd"`, and so on.
+Internal quotes in names should be escaped with backslashes: `chat."#channel"."say-\"hello\""`.
 
 [event-tag]: tags-event.html
 [external-tag]: tags-external.html

content/en/about-plugins.md

@@ -63,7 +63,7 @@ An event-handler plugin can stop later plugins from running by setting a `stopPr
 on the event object (`e.stopPropagation = true`). A plugin can stop the event from firing by setting
 a `preventDefault` property (`e.preventDefault = true`).
 
-#### Event: parseBegin
+#### Event: `parseBegin`
 
 The `parseBegin` event is fired before JSDoc starts loading and parsing the source files. Your
 plugin can control which files JSDoc will parse by modifying the event's contents.
@@ -74,7 +74,7 @@ The event object contains the following properties:
 
 + `sourcefiles`: An array of paths to source files that will be parsed.
 
-#### Event: fileBegin
+#### Event: `fileBegin`
 
 The `fileBegin` event is fired when the parser is about to parse a file. Your plugin can use this
 event to trigger per-file initialization if necessary.
@@ -83,7 +83,7 @@ The event object contains the following properties:
 
 + `filename`: The name of the file.
 
-#### Event: beforeParse
+#### Event: `beforeParse`
 
 The `beforeParse` event is fired before parsing has begun. Plugins can use this method to modify the
 source code that will be parsed. For instance, your plugin could add a JSDoc comment, or it could
@@ -118,7 +118,7 @@ exports.handlers = {
 ```
 {% endexample %}
 
-#### Event: jsdocCommentFound
+#### Event: `jsdocCommentFound`
 
 The `jsdocCommentFound` event is fired whenever a JSDoc comment is found. The comment may or may not
 be associated with any code. You might use this event to modify the contents of a comment before it
@@ -131,7 +131,7 @@ The event object contains the following properties:
 + `lineno`: The line number on which the comment was found.
 + `columnno`: The column number on which the comment was found. Available in JSDoc 3.5.0 and later.
 
-#### Event: symbolFound
+#### Event: `symbolFound`
 
 The `symbolFound` event is fired when the parser comes across a symbol in the code that may need to
 be documented. For example, the parser fires a `symbolFound` event for each variable, function, and
@@ -153,7 +153,7 @@ properties depending on the symbol.
 
 [node-visitors]: #node-visitors
 
-#### Event: newDoclet
+#### Event: `newDoclet`
 
 The `newDoclet` event is the highest-level event. It is fired when a new doclet has been created.
 This means that a JSDoc comment or a symbol has been processed, and the actual doclet that will be
@@ -206,7 +206,7 @@ exports.handlers = {
 
 [about-commandline]: about-commandline.html
 
-#### Event: fileComplete
+#### Event: `fileComplete`
 
 The `fileComplete` event is fired when the parser has finished parsing a file. Your plugin could use
 this event to trigger per-file cleanup.
@@ -216,7 +216,7 @@ The event object contains the following properties:
 + `filename`: The name of the file.
 + `source`: The contents of the file.
 
-#### Event: parseComplete
+#### Event: `parseComplete`
 
 The `parseComplete` event is fired after JSDoc has parsed all of the specified source files.
 
@@ -230,7 +230,7 @@ about the properties that each doclet can contain. Available in JSDoc 3.2.1 and
 
 [newdoclet-event]: #event-newdoclet
 
-#### Event: processingComplete
+#### Event: `processingComplete`
 
 The `processingComplete` event is fired after JSDoc updates the parse results to reflect inherited
 and borrowed symbols.

content/en/tags-abstract.md

@@ -7,7 +7,7 @@ synonyms:
 
 ## Overview
 
-The @abstract tag identifies members that must be implemented (or overridden) by objects that
+The `@abstract` tag identifies members that must be implemented (or overridden) by objects that
 inherit the member.
 
 ## Example

content/en/tags-alias.md

@@ -13,12 +13,12 @@ related:
 
 ## Overview
 
-The @alias tag causes JSDoc to treat all references to a member as if the member had a different
+The `@alias` tag causes JSDoc to treat all references to a member as if the member had a different
 name. This tag is especially useful if you define a class within an inner function; in this case,
-you can use the @alias tag to tell JSDoc how the class is exposed in your app.
+you can use the `@alias` tag to tell JSDoc how the class is exposed in your app.
 
-While the @alias tag may sound similar to the @name tag, these tags behave very differently. The
-@name tag tells JSDoc to ignore any code associated with the comment. For example, when JSDoc
+While the `@alias` tag may sound similar to the `@name` tag, these tags behave very differently. The
+`@name` tag tells JSDoc to ignore any code associated with the comment. For example, when JSDoc
 processes the following code, it ignores the fact that the comment for `bar` is attached to a
 function:
 
@@ -30,7 +30,7 @@ function:
 function foo() {}
 ```
 
-The @alias tag tells JSDoc to pretend that Member A is actually named Member B. For example, when
+The `@alias` tag tells JSDoc to pretend that <var>Member A</var> is actually named <var>Member B</var>. For example, when
 JSDoc processes the following code, it recognizes that `foo` is a function, then renames `foo` to
 `bar` in the documentation:
 
@@ -48,12 +48,12 @@ function foo() {}
 ## Examples
 
 Suppose you are using a class framework that expects you to pass in a constructor function when you
-define a class. You can use the @alias tag to tell JSDoc how the class will be exposed in your app.
+define a class. You can use the `@alias` tag to tell JSDoc how the class will be exposed in your app.
 
-In the following example, the @alias tag tells JSDoc to treat the anonymous function as if it were
-the constructor for the class "trackr.CookieManager". Within the function, JSDoc interprets the
-`this` keyword relative to trackr.CookieManager, so the "value" method has the namepath
-"trackr.CookieManager#value".
+In the following example, the `@alias` tag tells JSDoc to treat the anonymous function as if it were
+the constructor for the class `trackr.CookieManager`. Within the function, JSDoc interprets the
+`this` keyword relative to `trackr.CookieManager`, so the `value` method has the namepath
+`trackr.CookieManager#value`.
 
 {% example "Using @alias with an anonymous constructor function" %}
 
@@ -74,8 +74,8 @@ Klass('trackr.CookieManager',
 ```
 {% endexample %}
 
-You can also use the @alias tag with members that are created within an immediately invoked function
-expression (IIFE). The @alias tag tells JSDoc that these members are exposed outside of the IIFE's
+You can also use the `@alias` tag with members that are created within an immediately invoked function
+expression (IIFE). The `@alias` tag tells JSDoc that these members are exposed outside of the IIFE's
 scope.
 
 {% example "Using @alias for static members of a namespace" %}
@@ -99,8 +99,8 @@ var Apple = {};
 ```
 {% endexample %}
 
-For members that are defined within an object literal, you can use the @alias tag as an alternative
-to the [@lends][lends-tag] tag.
+For members that are defined within an object literal, you can use the `@alias` tag as an alternative
+to the [`@lends`][lends-tag] tag.
 
 {% example "Using @alias for an object literal" %}
 

content/en/tags-author.md

@@ -13,7 +13,7 @@ related:
 
 ## Overview
 
-The @author tag identifies the author of an item. In JSDoc 3.2 and later, if the author's name is
+The `@author` tag identifies the author of an item. In JSDoc 3.2 and later, if the author's name is
 followed by an email address enclosed in angle brackets, the default template will convert the email
 address to a `mailto:` link.
 

content/en/tags-borrows.md

@@ -10,15 +10,15 @@ description: This object uses something from another object.
 
 ## Overview
 
-The @borrows tag allows you to add documentation for another symbol to your documentation.
+The `@borrows` tag allows you to add documentation for another symbol to your documentation.
 
 This tag would be useful if you had more than one way to reference a function, but you didn't want
 to duplicate the same documentation in two places.
 
 
 ## Examples
 
-In this example there exists documentation for the "trstr" function, but "util.trim" is just a
+In this example there exists documentation for the `trstr` function, but `util.trim` is just a
 reference to that same function by a different name.
 
 {% example "Duplicate the documentation for trstr as util.trim" %}

content/en/tags-callback.md

@@ -13,12 +13,12 @@ related:
 
 ## Overview
 
-The @callback tag provides information about a callback function that can be passed to other
+The `@callback` tag provides information about a callback function that can be passed to other
 functions, including the callback's parameters and return value. You can include any of the tags
-that you can provide for a @method.
+that you can provide for a `@method`.
 
 Once you define a callback, you can use it in the same way as a custom type defined with the
-@typedef tag. In particular, you can use the callback's name as a type name. This allows you to
+`@typedef` tag. In particular, you can use the callback's name as a type name. This allows you to
 indicate that a function parameter should contain a certain type of callback.
 
 If you want a callback to be displayed with the type definitions for a specific class, you can give

content/en/tags-class.md

@@ -14,7 +14,7 @@ related:
 
 ## Overview
 
-The @class tag marks a function as being a constructor, meant to be called with the new
+The `@class` tag marks a function as being a constructor, meant to be called with the `new`
 keyword to return an instance.
 
 

content/en/tags-classdesc.md

@@ -13,13 +13,13 @@ related:
 
 ## Overview
 
-The @classdesc tag is used to provide a description for a class, separate from the constructor
-function's description. Use the @classdesc tag in combination with the [@class (or @constructor)
+The `@classdesc` tag is used to provide a description for a class, separate from the constructor
+function's description. Use the `@classdesc` tag in combination with the [`@class` (or `@constructor`)
 tag][class-tag].
 
-The functionality of the @classdesc tag in JSDoc 3 duplicates that of the @class in previous
-versions. As of version 3, the syntax and functionality of the @class tag now exactly matches the
-@constructor tag, and the @classdesc tag more explicitly communicates its purpose: to document a
+The functionality of the `@classdesc` tag in JSDoc 3 duplicates that of the `@class` in previous
+versions. As of version 3, the syntax and functionality of the `@class` tag now exactly matches the
+`@constructor` tag, and the `@classdesc` tag more explicitly communicates its purpose: to document a
 class's description.
 
 [class-tag]: tags-class.html

content/en/tags-constant.md

@@ -15,14 +15,14 @@ related:
 
 ## Overview
 
-The @constant tag is used to mark the documentation as belonging to a symbol that is a constant.
+The `@constant` tag is used to mark the documentation as belonging to a symbol that is a constant.
 
 
 ## Examples
 
 In this example we are documenting a string constant. Note that although the code is using the
 `const` keyword, this is not required by JSDoc. If your JavaScript host environment doesn't yet
-support constant declarations, the @const documentation can just as effectively be used on `var`
+support constant declarations, the `@const` documentation can just as effectively be used on `var`
 declarations.
 
 {% example "A string constant representing the color red" %}
@@ -39,6 +39,6 @@ var ONE = 1;
 ```
 {% endexample %}
 
-Note that the example provides the type in a @type tag. This is optional. Also the optional
-@default tag is used here too, this will automatically add whatever the assigned value is (for
-example 'FF0000') to the documentation.
+Note that the example provides the type in a `@type` tag. This is optional. Also the optional
+`@default` tag is used here too, this will automatically add whatever the assigned value is (for
+example `'FF0000'`) to the documentation.

content/en/tags-copyright.md

@@ -12,8 +12,8 @@ related:
 
 ## Overview
 
-The @copyright tag is used to document copyright information in a file overview comment. Use this
-tag in combination with the [@file tag][file-tag].
+The `@copyright` tag is used to document copyright information in a file overview comment. Use this
+tag in combination with the [`@file` tag][file-tag].
 
 [file-tag]: tags-file.html
 

content/en/tags-default.md

@@ -12,7 +12,7 @@ synonyms:
 
 ## Overview
 
-The @default tag allows you to document the assigned value of a symbol. You can supply this tag with
+The `@default` tag allows you to document the assigned value of a symbol. You can supply this tag with
 a value yourself or you can allow JSDoc to automatically document the value from the source code --
 only possible when the documented symbol is being assigned a single, simple value that is either: a
 string, a number, a boolean or null.
@@ -21,7 +21,7 @@ string, a number, a boolean or null.
 ## Examples
 
 In this example a constant is documented. The value of the constant is `0xff0000`. By adding the
-@default tag this value is automatically added to the documentation.
+`@default` tag this value is automatically added to the documentation.
 
 {% example "Document the number value of a constant" %}
 

content/en/tags-deprecated.md

@@ -10,11 +10,11 @@ description: Document that this is no longer the preferred way.
 
 ## Overview
 
-The @deprecated tag marks a symbol in your code as being deprecated.
+The `@deprecated` tag marks a symbol in your code as being deprecated.
 
 ## Examples
 
-You can use the @deprecated tag by itself, or include some text that describes more about the
+You can use the `@deprecated` tag by itself, or include some text that describes more about the
 deprecation.
 
 {% example "Document that the old function has been deprecated since version 2.0" %}

content/en/tags-description.md

@@ -15,7 +15,7 @@ related:
 
 ## Overview
 
-The @description tag allows you to provide a general description of the symbol you are documenting.
+The `@description` tag allows you to provide a general description of the symbol you are documenting.
 The description may include HTML markup. It may also include Markdown formatting if the
 [Markdown plugin][markdown-plugin] is enabled.
 
@@ -25,7 +25,7 @@ The description may include HTML markup. It may also include Markdown formatting
 ## Examples
 
 If you describe a symbol at the very beginning of a JSDoc comment, before using any block tags, you
-may omit the @description tag.
+may omit the `@description` tag.
 
 {% example "Describing a symbol without the @description tag" %}
 
@@ -42,7 +42,7 @@ function add(a, b) {
 ```
 {% endexample %}
 
-By using the @description tag, you can place the description anywhere in the JSDoc comment.
+By using the `@description` tag, you can place the description anywhere in the JSDoc comment.
 
 {% example "Describing a symbol with the @description tag" %}
 
@@ -59,4 +59,4 @@ function add(a, b) {
 ```
 {% endexample %}
 
-If there's both a description at the beginning of a JSDoc comment and a description provided with the @description tag, the description specified with the @description will override the description at the beginning of the comment.
+If there's both a description at the beginning of a JSDoc comment and a description provided with the `@description` tag, the description specified with the `@description` will override the description at the beginning of the comment.