fix(markdown): Change optional parameter doc format from man page to JavaScript
This commit is contained in:
parent
bf4b4c8755
commit
c2d5b943b6
6 changed files with 7 additions and 7 deletions
|
@ -7,7 +7,7 @@ The `Path.addText()` method adds text to the path.
|
|||
## Signature
|
||||
|
||||
```js
|
||||
Path path.addText(string text[, string className])
|
||||
Path path.addText(string text, string className = '')
|
||||
```
|
||||
|
||||
The second argument will optionally be used to set the CSS class for the text.
|
||||
|
|
|
@ -13,8 +13,8 @@ instead, thereby overwriting the value of the attribute.
|
|||
```js
|
||||
Path path.attr(
|
||||
string name,
|
||||
mixed value[,
|
||||
bool overwrite = false]
|
||||
mixed value,
|
||||
bool overwrite = false
|
||||
)
|
||||
```
|
||||
|
||||
|
|
|
@ -12,7 +12,7 @@ If that's not what you want, you should use
|
|||
## Signature
|
||||
|
||||
```js
|
||||
Path path.join(path other[, bool closed=false])
|
||||
Path path.join(path other, bool closed = false)
|
||||
```
|
||||
|
||||
The second argument will optionally be used to close the joined path.
|
||||
|
|
|
@ -7,7 +7,7 @@ The `Path.setText()` method sets text on the path.
|
|||
## Signature
|
||||
|
||||
```js
|
||||
Path path.setText(string text[, string className])
|
||||
Path path.setText(string text, string className = '')
|
||||
```
|
||||
|
||||
The second argument will optionally be used to set the CSS class for the text.
|
||||
|
|
|
@ -8,7 +8,7 @@ along the path.
|
|||
## Signature
|
||||
|
||||
```js
|
||||
Point path.shiftAlong(float distance[, int stepsPerMm=10])
|
||||
Point path.shiftAlong(float distance, int stepsPerMm = 10)
|
||||
```
|
||||
|
||||
The second parameter controls the precision by which the path will be _walked_.
|
||||
|
|
|
@ -8,7 +8,7 @@ length of the path travelled along the path.
|
|||
## Signature
|
||||
|
||||
```js
|
||||
Point path.shiftFractionAlong(float fraction[, int stepsPerMm=25])
|
||||
Point path.shiftFractionAlong(float fraction, int stepsPerMm = 25)
|
||||
```
|
||||
|
||||
The second parameter controls the precision by which the path will be _walked_.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue