|
@@ -102,7 +102,7 @@ Using `autoUpdater` as an example:
|
|
|
* [Static Methods](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes/static) must be listed under a `### Static Methods` chapter.
|
|
|
* [Instance Methods](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Prototype_methods) must be listed under an `### Instance Methods` chapter.
|
|
|
* All methods that have a return value must start their description with "Returns `[TYPE]` - Return description"
|
|
|
- * If the method returns an `Object` with a given structure that structure can be specified with a color followed by a newline then an unordered list of properties in the same style as function parameters
|
|
|
+ * If the method returns an `Object`, its structure can be specified using a colon followed by a newline then an unordered list of properties in the same style as function parameters.
|
|
|
* Instance Events must be listed under an `### Instance Events` chapter.
|
|
|
* Instance Properties must be listed under an `### Instance Properties` chapter.
|
|
|
* Instance properties must start with "A [Property Type] ..."
|