document mustNotHaveDescription option for tag plugins (#56)

Author: hegemonic

about-plugins.html

@@ -221,12 +221,13 @@ <h4 id="the-dictionary">The Dictionary</h4>
       <li><code>defineTag(title, opts)</code>: Used to define tags. The first parameter is the name of the tag (for example, <code>param</code> or <code>overview</code>).
         The second is an object containing options for the tag. You can include any of the following options; the default value for each option is <code>false</code>:
         <ul>
-          <li><code>mustHaveValue (boolean)</code>: Set to <code>true</code> if the tag must have a value (such as <code>TheName</code> in <code>@name TheName</code>).</li>
-          <li><code>mustNotHaveValue (boolean)</code>: Set to <code>true</code> if the tag must not have a value.</li>
           <li><code>canHaveType (boolean)</code>: Set to <code>true</code> if the tag text can include a type expression (such as <code>{string}</code> in <code>@param {string} name - Description</code>).</li>
           <li><code>canHaveName (boolean)</code>: Set to <code>true</code> if the tag text can include a name (such as <code>name</code> in <code>@param {string} name - Description</code>).</li>
           <li><code>isNamespace (boolean)</code>: Set to <code>true</code> if the tag should be applied to the doclet&#39;s longname as a namespace. For example, the
             <code>@module</code> tag sets this option to <code>true</code>, and using the tag <code>@module myModuleName</code> results in the longname <code>module:myModuleName</code>.</li>
+          <li><code>mustHaveValue (boolean)</code>: Set to <code>true</code> if the tag must have a value (such as <code>TheName</code> in <code>@name TheName</code>).</li>
+          <li><code>mustNotHaveDescription (boolean)</code>: Set to <code>true</code> if the tag may have a value but must not have a description (such as <code>TheDescription</code>            in <code>@tag {typeExpr} TheDescription</code>).</li>
+          <li><code>mustNotHaveValue (boolean)</code>: Set to <code>true</code> if the tag must not have a value.</li>
           <li><code>onTagged (function)</code>: A callback function executed when the tag is found. The function is passed two parameters: the doclet and the tag object.</li>
         </ul>
       </li>

content/en/about-plugins.md

@@ -219,11 +219,12 @@ exports.defineTags = function(dictionary) {
 The dictionary provides the following methods:
 
 + `defineTag(title, opts)`: Used to define tags. The first parameter is the name of the tag (for example, `param` or `overview`). The second is an object containing options for the tag. You can include any of the following options; the default value for each option is `false`:
-    + `mustHaveValue (boolean)`: Set to `true` if the tag must have a value (such as `TheName` in `@name TheName`).
-    + `mustNotHaveValue (boolean)`: Set to `true` if the tag must not have a value.
     + `canHaveType (boolean)`: Set to `true` if the tag text can include a type expression (such as `{string}` in `@param {string} name - Description`).
     + `canHaveName (boolean)`: Set to `true` if the tag text can include a name (such as `name` in `@param {string} name - Description`).
     + `isNamespace (boolean)`: Set to `true` if the tag should be applied to the doclet's longname as a namespace. For example, the `@module` tag sets this option to `true`, and using the tag `@module myModuleName` results in the longname `module:myModuleName`.
+    + `mustHaveValue (boolean)`: Set to `true` if the tag must have a value (such as `TheName` in `@name TheName`).
+    + `mustNotHaveDescription (boolean)`: Set to `true` if the tag may have a value but must not have a description (such as `TheDescription` in `@tag {typeExpr} TheDescription`).
+    + `mustNotHaveValue (boolean)`: Set to `true` if the tag must not have a value.
     + `onTagged (function)`: A callback function executed when the tag is found. The function is passed two parameters: the doclet and the tag object.
 + `lookUp(tagName)`: Retrieve a tag object by name. Returns the tag object, including its options, or `false` if the tag is not defined.
 + `isNamespace(tagName)`: Returns `true` if the tag is applied to a doclet's longname as a namespace.