docs: Add element documentation coverage

Author: kylef

Diff for: src/elements/asset.js

@@ -1,18 +1,36 @@
 export default function (namespace) {
+  /**
+   * @class Asset
+   *
+   * @param {string} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends Element
+   */
   class Asset extends namespace.Element {
     constructor(...args) {
       super(...args);
       this.element = 'asset';
     }
 
+    /**
+     * @name contentType
+     * @type StringElement
+     * @memberof Asset.prototype
+     */
     get contentType() {
       return this.attributes.get('contentType');
     }
 
     set contentType(value) {
       this.attributes.set('contentType', value);
     }
-
+    /**
+     * @name href
+     * @type StringElement
+     * @memberof Asset.prototype
+     */
     get href() {
       return this.attributes.get('href');
     }

Diff for: src/elements/auth-scheme.js

@@ -1,16 +1,35 @@
 export default function (namespace) {
   const ArrayElement = namespace.getElementClass('array');
 
+  /**
+   * @class AuthScheme
+   *
+   * @param {Array} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends ArrayElement
+   */
   class AuthScheme extends ArrayElement {
     constructor(...args) {
       super(...args);
       this.element = 'authScheme';
     }
 
+    /**
+     * @name transitions
+     * @type ArraySlice
+     * @memberof HttpMessagePayload.prototype
+     */
     get transitions() {
       return this.children.filter(item => item.element === 'transition');
     }
 
+    /**
+     * @name members
+     * @type ArraySlice
+     * @memberof HttpMessagePayload.prototype
+     */
     get members() {
       return this.children.filter(item => item.element === 'member');
     }

Diff for: src/elements/category.js

@@ -1,16 +1,35 @@
 export default function (namespace) {
   const ArrayElement = namespace.getElementClass('array');
 
+  /**
+   * @class Category
+   *
+   * @param {Array} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends ArrayElement
+   */
   class Category extends ArrayElement {
     constructor(...args) {
       super(...args);
       this.element = 'category';
     }
 
+    /**
+     * @name resourceGroups
+     * @type ArraySlice
+     * @memberof Category.prototype
+     */
     get resourceGroups() {
       return this.children.filter(item => item.classes.contains('resourceGroup'));
     }
 
+    /**
+     * @name dataStructures
+     * @type ArraySlice
+     * @memberof Category.prototype
+     */
     get dataStructures() {
       return this.children.filter(item => item.classes.contains('dataStructures'));
     }
@@ -23,18 +42,38 @@ export default function (namespace) {
       return this.children.filter(item => item.classes.contains('transitions'));
     }
 
+    /**
+     * @name authSchemes
+     * @type ArraySlice
+     * @memberof Category.prototype
+     */
     get authSchemeGroups() {
       return this.children.filter(item => item.classes.contains('authSchemes'));
     }
 
+    /**
+     * @name resources
+     * @type ArraySlice
+     * @memberof Category.prototype
+     */
     get resources() {
       return this.children.filter(item => item.element === 'resource');
     }
 
+    /**
+     * @name transitions
+     * @type ArraySlice
+     * @memberof Category.prototype
+     */
     get transitions() {
       return this.children.filter(item => item.element === 'transition');
     }
 
+    /**
+     * @name authSchemes
+     * @type ArraySlice
+     * @memberof Category.prototype
+     */
     get authSchemes() {
       const schemes = ['Basic Authentication Scheme', 'Token Authentication Scheme', 'OAuth2 Scheme'];
       return this.children.filter(item => schemes.indexOf(item.element) !== -1);

Diff for: src/elements/copy.js

@@ -2,6 +2,11 @@ export default function (namespace) {
   const StringElement = namespace.getElementClass('string');
   const ArrayElement = namespace.getElementClass('array');
 
+  /**
+   * @name copy
+   * @type Copy
+   * @memberof Element.prototype
+   */
   if (!Object.getOwnPropertyNames(ArrayElement.prototype).includes('copy')) {
     Object.defineProperty(ArrayElement.prototype, 'copy', {
       get() {
@@ -10,12 +15,26 @@ export default function (namespace) {
     });
   }
 
+  /**
+   * @class Copy
+   *
+   * @param {string} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends StringElement
+   */
   class Copy extends StringElement {
     constructor(...args) {
       super(...args);
       this.element = 'copy';
     }
 
+    /**
+     * @name contentType
+     * @type StringElement
+     * @memberof Copy.prototype
+     */
     get contentType() {
       return this.attributes.get('contentType');
     }

Diff for: src/elements/data-structure.js

@@ -1,4 +1,13 @@
 export default function (namespace) {
+  /**
+   * @class DataStructure
+   *
+   * @param {Element} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends Element
+   */
   class DataStructure extends namespace.Element {
     constructor(...args) {
       super(...args);

Diff for: src/elements/enum.js

@@ -1,12 +1,26 @@
 export default function (namespace) {
   const ArrayElement = namespace.getElementClass('array');
 
+  /**
+   * @class Enum
+   *
+   * @param {Element} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends Element
+   */
   class Enum extends namespace.Element {
     constructor(content, meta, attributes) {
       super(namespace.toElement(content), meta, attributes);
       this.element = 'enum';
     }
 
+    /**
+     * @name enumerations
+     * @type ArrayElement
+     * @memberof Enum.prototype
+     */
     get enumerations() {
       return this.attributes.get('enumerations');
     }

Diff for: src/elements/href-variables.js

@@ -1,6 +1,15 @@
 export default function (namespace) {
   const ObjectElement = namespace.getElementClass('object');
 
+  /**
+   * @class HrefVariables
+   *
+   * @param {Array} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends ObjectElement
+   */
   class HrefVariables extends ObjectElement {
     constructor(...args) {
       super(...args);

Diff for: src/elements/http-headers.js

@@ -1,6 +1,15 @@
 export default function (namespace) {
   const ArrayElement = namespace.getElementClass('array');
 
+  /**
+   * @class HttpHeaders
+   *
+   * @param {Array} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends ArrayElement
+   */
   class HttpHeaders extends ArrayElement {
     constructor(...args) {
       super(...args);

Diff for: src/elements/http-message-payload.js

@@ -4,7 +4,21 @@ import httpResponse from './http-response';
 export default function (namespace) {
   const ArrayElement = namespace.getElementClass('array');
 
+  /**
+   * @class HttpMessagePayload
+   *
+   * @param {Array} content
+   * @param meta
+   * @param attributes
+   *
+   * @extends ArrayElement
+   */
   class HttpMessagePayload extends ArrayElement {
+    /**
+     * @name headers
+     * @type HttpHeaders
+     * @memberof HttpMessagePayload.prototype
+     */
     get headers() {
       return this.attributes.get('headers');
     }
@@ -24,6 +38,11 @@ export default function (namespace) {
       return header;
     }
 
+    /**
+     * @name contentType
+     * @type StringElement
+     * @memberof HttpMessagePayload.prototype
+     */
     get contentType() {
       const header = this.header('Content-Type');
 
@@ -34,16 +53,31 @@ export default function (namespace) {
       return this.content && this.content.contentType;
     }
 
+    /**
+     * @name dataStructure
+     * @type Asset
+     * @memberof HttpMessagePayload.prototype
+     */
     get dataStructure() {
       return this.findByElement('dataStructure').first;
     }
 
+    /**
+     * @name messageBody
+     * @type Asset
+     * @memberof HttpMessagePayload.prototype
+     */
     get messageBody() {
       // Returns the *first* message body. Only one should be defined according
       // to the spec, but it's possible to include more.
       return this.filter(item => item.element === 'asset' && item.classes.contains('messageBody')).first;
     }
 
+    /**
+     * @name messageBodySchema
+     * @type Asset
+     * @memberof HttpMessagePayload.prototype
+     */
     get messageBodySchema() {
       // Returns the *first* message body schema. Only one should be defined
       // according to the spec, but it's possible to include more.

Diff for: src/elements/http-request.js

@@ -1,10 +1,24 @@
 export default function (namespace, HttpMessagePayload) {
+  /**
+   * @class HttpRequest
+   *
+   * @param content
+   * @param meta
+   * @param attributes
+   *
+   * @extends HttpMessagePayload
+   */
   class HttpRequest extends HttpMessagePayload {
     constructor(...args) {
       super(...args);
       this.element = 'httpRequest';
     }
 
+    /**
+     * @name method
+     * @type StringElement
+     * @memberof HttpRequest.prototype
+     */
     get method() {
       return this.attributes.get('method');
     }
@@ -13,6 +27,11 @@ export default function (namespace, HttpMessagePayload) {
       this.attributes.set('method', value);
     }
 
+    /**
+     * @name href
+     * @type StringElement
+     * @memberof HttpRequest.prototype
+     */
     get href() {
       return this.attributes.get('href');
     }

Diff for: src/elements/http-response.js

@@ -1,10 +1,24 @@
 export default function (namespace, HttpMessagePayload) {
+  /**
+   * @class HttpResponse
+   *
+   * @param content
+   * @param meta
+   * @param attributes
+   *
+   * @extends HttpMessagePayload
+   */
   class HttpResponse extends HttpMessagePayload {
     constructor(...args) {
       super(...args);
       this.element = 'httpResponse';
     }
 
+    /**
+     * @name statusCode
+     * @type NumberElement
+     * @memberof HttpResponse.prototype
+     */
     get statusCode() {
       return this.attributes.get('statusCode');
     }