Skip to content

Commit

Permalink
docs(api): specify property
Browse files Browse the repository at this point in the history
Use @Property and @memberof to specify a static getter.

#44,#187
  • Loading branch information
gregswindle committed Feb 18, 2018
1 parent 0807583 commit 6993580
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion lib/crc/crc-class.js
Original file line number Diff line number Diff line change
Expand Up @@ -104,11 +104,12 @@ class CrcClass {

/**
* @static
* @description A CrcClass NullObject.
* @property {NullCrcClass} nullObject - A CrcClass NullObject.
*
* 🔒 **Note:** `NullCrcClass` instances can **only** be created
* using the static getter `CrcClass.nullObject`.
* @type NullCrcClass
* @memberof CrcClass
* @returns {NullCrcClass} A CrcClass NullObject.
*/

Expand Down

0 comments on commit 6993580

Please sign in to comment.