ByoungSooPark/modeling-app
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Regenerate docs

Browse Source
This commit is contained in:
Adam Chalmers
2023-09-18 10:45:14 -05:00
parent d8102252e1
commit a91d8c07b6
2 changed files with 227 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files

224
docs/kcl/std.json
View File

@ -514,10 +514,18 @@
], ],
"returnValue": { "returnValue": {
"name": "", "name": "",
"type": "number", "type": "Angle",
"schema": { "schema": {
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"required": true "required": true
}, },
@ -983,10 +991,18 @@
], ],
"returnValue": { "returnValue": {
"name": "", "name": "",
"type": "number", "type": "Angle",
"schema": { "schema": {
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"required": true "required": true
}, },
@ -1016,8 +1032,16 @@
"properties": { "properties": {
"angle": { "angle": {
"description": "The angle of the line.", "description": "The angle of the line.",
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"length": { "length": {
"description": "The length of the line.", "description": "The length of the line.",
@ -1033,10 +1057,24 @@
{ {
"description": "An angle and length.", "description": "An angle and length.",
"type": "array", "type": "array",
"items": { "items": [
"type": "number", {
"format": "double" "type": "object",
}, "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
},
{
"type": "number",
"format": "double"
}
],
"maxItems": 2, "maxItems": 2,
"minItems": 2 "minItems": 2
} }
@ -1937,8 +1975,16 @@
"properties": { "properties": {
"angle": { "angle": {
"description": "The angle of the line.", "description": "The angle of the line.",
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"length": { "length": {
"description": "The length of the line.", "description": "The length of the line.",
@ -1954,10 +2000,24 @@
{ {
"description": "An angle and length.", "description": "An angle and length.",
"type": "array", "type": "array",
"items": { "items": [
"type": "number", {
"format": "double" "type": "object",
}, "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
},
{
"type": "number",
"format": "double"
}
],
"maxItems": 2, "maxItems": 2,
"minItems": 2 "minItems": 2
} }
@ -2858,8 +2918,16 @@
"properties": { "properties": {
"angle": { "angle": {
"description": "The angle of the line.", "description": "The angle of the line.",
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"length": { "length": {
"description": "The length of the line.", "description": "The length of the line.",
@ -2875,10 +2943,24 @@
{ {
"description": "An angle and length.", "description": "An angle and length.",
"type": "array", "type": "array",
"items": { "items": [
"type": "number", {
"format": "double" "type": "object",
}, "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
},
{
"type": "number",
"format": "double"
}
],
"maxItems": 2, "maxItems": 2,
"minItems": 2 "minItems": 2
} }
@ -3775,8 +3857,16 @@
"properties": { "properties": {
"angle": { "angle": {
"description": "The angle of the line.", "description": "The angle of the line.",
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"intersectTag": { "intersectTag": {
"description": "The tag of the line to intersect with.", "description": "The tag of the line to intersect with.",
@ -4690,8 +4780,16 @@
"properties": { "properties": {
"angle": { "angle": {
"description": "The angle of the line.", "description": "The angle of the line.",
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"tag": { "tag": {
"description": "The tag.", "description": "The tag.",
@ -4707,10 +4805,24 @@
{ {
"description": "An angle and point to draw to.", "description": "An angle and point to draw to.",
"type": "array", "type": "array",
"items": { "items": [
"type": "number", {
"format": "double" "type": "object",
}, "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
},
{
"type": "number",
"format": "double"
}
],
"maxItems": 2, "maxItems": 2,
"minItems": 2 "minItems": 2
} }
@ -5611,8 +5723,16 @@
"properties": { "properties": {
"angle": { "angle": {
"description": "The angle of the line.", "description": "The angle of the line.",
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"tag": { "tag": {
"description": "The tag.", "description": "The tag.",
@ -5628,10 +5748,24 @@
{ {
"description": "An angle and point to draw to.", "description": "An angle and point to draw to.",
"type": "array", "type": "array",
"items": { "items": [
"type": "number", {
"format": "double" "type": "object",
}, "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
},
{
"type": "number",
"format": "double"
}
],
"maxItems": 2, "maxItems": 2,
"minItems": 2 "minItems": 2
} }
@ -13889,10 +14023,18 @@
], ],
"returnValue": { "returnValue": {
"name": "", "name": "",
"type": "number", "type": "Angle",
"schema": { "schema": {
"type": "number", "type": "object",
"format": "double" "required": [
"degrees"
],
"properties": {
"degrees": {
"type": "number",
"format": "double"
}
}
}, },
"required": true "required": true
}, },

61
docs/kcl/std.md
View File

@ -106,7 +106,7 @@ Returns the angle to match the given length for x.
``` ```
angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> number angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup) -> Angle
``` ```
#### Arguments #### Arguments
@ -179,7 +179,12 @@ angleToMatchLengthX(segment_name: string, to: number, sketch_group: SketchGroup)
#### Returns #### Returns
* `number` * `Angle`
```
{
degrees: number,
}
```
@ -190,7 +195,7 @@ Returns the angle to match the given length for y.
``` ```
angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> number angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup) -> Angle
``` ```
#### Arguments #### Arguments
@ -263,7 +268,12 @@ angleToMatchLengthY(segment_name: string, to: number, sketch_group: SketchGroup)
#### Returns #### Returns
* `number` * `Angle`
```
{
degrees: number,
}
```
@ -283,13 +293,15 @@ angledLine(data: AngledLineData, sketch_group: SketchGroup) -> SketchGroup
``` ```
{ {
// The angle of the line. // The angle of the line.
angle: number, angle: {
degrees: number,
},
// The length of the line. // The length of the line.
length: number, length: number,
// The tag. // The tag.
tag: string, tag: string,
} | } |
[number] string
``` ```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths.
``` ```
@ -439,13 +451,15 @@ angledLineOfXLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGr
``` ```
{ {
// The angle of the line. // The angle of the line.
angle: number, angle: {
degrees: number,
},
// The length of the line. // The length of the line.
length: number, length: number,
// The tag. // The tag.
tag: string, tag: string,
} | } |
[number] string
``` ```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths.
``` ```
@ -595,13 +609,15 @@ angledLineOfYLength(data: AngledLineData, sketch_group: SketchGroup) -> SketchGr
``` ```
{ {
// The angle of the line. // The angle of the line.
angle: number, angle: {
degrees: number,
},
// The length of the line. // The length of the line.
length: number, length: number,
// The tag. // The tag.
tag: string, tag: string,
} | } |
[number] string
``` ```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths.
``` ```
@ -751,7 +767,9 @@ angledLineThatIntersects(data: AngeledLineThatIntersectsData, sketch_group: Sket
``` ```
{ {
// The angle of the line. // The angle of the line.
angle: number, angle: {
degrees: number,
},
// The tag of the line to intersect with. // The tag of the line to intersect with.
intersectTag: string, intersectTag: string,
// The offset from the intersecting line. // The offset from the intersecting line.
@ -908,13 +926,15 @@ angledLineToX(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
``` ```
{ {
// The angle of the line. // The angle of the line.
angle: number, angle: {
degrees: number,
},
// The tag. // The tag.
tag: string, tag: string,
// The point to draw to. // The point to draw to.
to: number, to: number,
} | } |
[number] string
``` ```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths.
``` ```
@ -1064,13 +1084,15 @@ angledLineToY(data: AngledLineToData, sketch_group: SketchGroup) -> SketchGroup
``` ```
{ {
// The angle of the line. // The angle of the line.
angle: number, angle: {
degrees: number,
},
// The tag. // The tag.
tag: string, tag: string,
// The point to draw to. // The point to draw to.
to: number, to: number,
} | } |
[number] string
``` ```
* `sketch_group`: `SketchGroup` - A sketch group is a collection of paths. * `sketch_group`: `SketchGroup` - A sketch group is a collection of paths.
``` ```
@ -2680,7 +2702,7 @@ Returns the angle of the segment.
``` ```
segAng(segment_name: string, sketch_group: SketchGroup) -> number segAng(segment_name: string, sketch_group: SketchGroup) -> Angle
``` ```
#### Arguments #### Arguments
@ -2752,7 +2774,12 @@ segAng(segment_name: string, sketch_group: SketchGroup) -> number
#### Returns #### Returns
* `number` * `Angle`
```
{
degrees: number,
}
```