jsDoc corrections #186
jsDoc corrections #186
Conversation
|
Hi @trych I'll review this weekend. Thank you |
|
Aaaand updated the bundle as well (oops...) |
basil.js
Outdated
| * | ||
| * @cat Document | ||
| * @subcat Primitives | ||
| * @method beginShape | ||
| * @param shapeMode Set b.CLOSE if the new Path should be auto-closed. | ||
| * @param {String} shapeMode Set tob.CLOSE if the new Path should be auto-closed. |
There was a problem hiding this comment.
Missing whitespace. "tob" should be "to b"
src/includes/shape.js
Outdated
| * | ||
| * @cat Document | ||
| * @subcat Primitives | ||
| * @method beginShape | ||
| * @param shapeMode Set b.CLOSE if the new Path should be auto-closed. | ||
| * @param {String} shapeMode Set tob.CLOSE if the new Path should be auto-closed. |
| * <b>ellipseMode()</b> function. | ||
| * The <b>start</b> and <b>stop</b> parameters specify the angles | ||
| * at which to draw the arc. | ||
| * The arc() function draws an arc. Arcs are drawn along the outer edge of an ellipse |
There was a problem hiding this comment.
If HTML tags are used it needs the @description tag.
There was a problem hiding this comment.
Ok, I will take the HTML tags out for now, as they are not used throughout the docs consistently. We can later decide if we should use HTML tags for certain things, but if we do so, we should do it consistently and not in a few random functions.
| * @param {PageItem|String} pageItemOrName A page item whose style to return or the name of the object style to return. | ||
| * @param {Object} [props] Optional: An object of property name/value pairs to set the style's properties. | ||
| * @return {ObjectStyle} The object style instance. | ||
| * @param {PageItem|String} itemOrName A page item whose style to return or the name of the object style to return. |
There was a problem hiding this comment.
Because that is what the argument is called in the function itself. Not sure, if that needs to be consistent, in other places it looked like it was consistent. Should I rename it to pageItemOrName? Then it would also go ahead and rename in the function itself, right?
There was a problem hiding this comment.
Oh. Okay. I got confused. If the parameter is named like that keep it.
|
Ok, fixed. (Is there any GitHub way to mark your review comments as fixed?) |
|
I think I have to |
Making attributes consistent and improving function descriptions as discussed in #171.
Please review, if this was done correctly.
Closes #174.