Module: jsdoc/name

Longnames that have a special meaning in JSDoc.

Names and punctuation marks that identify doclet scopes.

Check whether a parent longname is an ancestor of a child longname.

Convert an array of doclet longnames into a tree structure, optionally attaching doclets to the
tree.

Each level of the tree is an object with the following properties:

• longname {string}: The longname.
• memberof {string?}: The memberof.
• scope {string?}: The longname's scope, represented as a punctuation mark (for example, #
  for instance and . for static).
• name {string}: The short name.
• doclet {Object?}: The doclet associated with the longname, or null if the doclet was not
  provided.
• children {Object?}: The children of the current longname. Not present if there are no
  children.

For example, suppose you have the following array of doclet longnames:

[
  "module:a",
  "module:a/b",
  "myNamespace",
  "myNamespace.Foo",
  "myNamespace.Foo#bar"
]

This method converts these longnames to the following tree:

{
  "module:a": {
    "longname": "module:a",
    "memberof": "",
    "scope": "",
    "name": "module:a",
    "doclet": null,
    "children": {
      "/b": {
        "longname": "module:a/b",
        "memberof": "module:a",
        "scope": "/",
        "name": "b",
        "doclet": null
      }
    }
  },
  "myNamespace": {
    "longname": "myNamespace",
    "memberof": "",
    "scope": "",
    "name": "myNamespace",
    "doclet": null,
    "children": {
      ".Foo": {
        "longname": "myNamespace.Foo",
        "memberof": "myNamespace",
        "scope": ".",
        "name": "Foo",
        "doclet": null,
        "children": {
          "#bar": {
            "longname": "myNamespace.Foo#bar",
            "memberof": "myNamespace.Foo",
            "scope": "#",
            "name": "bar",
            "doclet": null
          }
        }
      }
    }
  }
}

Resolves the longname, memberof, variation and name values of the given doclet.

Given a longname like "a.b#c(2)", slice it up into an object containing the memberof, the scope,
the name, and variation.

Split a string that starts with a name and ends with a description into its parts.

Split a string that starts with a name and ends with a description into its parts. Allows the
defaultvalue (if present) to contain brackets. If the name is found to have mismatched brackets,
null is returned.