Skip to content

Commit e0e1444

Browse files
Added sript transforming api annotations to markdown
1 parent 908aead commit e0e1444

34 files changed

+1998
-1148
lines changed

apireference.js

Lines changed: 842 additions & 89 deletions
Large diffs are not rendered by default.

apireference.json

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
11
{
2-
"destination": "apireference\\",
3-
"source": "min\\primitives.latest.js"
2+
"destination": "apireference/",
3+
"source": "./min/primitives.latest.js",
4+
"orgdiagram.md": [
5+
"Config",
6+
"ItemConfig",
7+
"TemplateConfig",
8+
"ShapeAnnotationConfig",
9+
"BackgroundAnnotationConfig",
10+
"ConnectorAnnotationConfig",
11+
"HighlightPathAnnotationConfig",
12+
"ButtonConfig"
13+
],
14+
"famdiagram.md": [
15+
"Config",
16+
"ItemConfig",
17+
"TemplateConfig",
18+
"ShapeAnnotationConfig",
19+
"BackgroundAnnotationConfig",
20+
"ConnectorAnnotationConfig",
21+
"HighlightPathAnnotationConfig",
22+
"LabelAnnotationConfig",
23+
"PaletteItemConfig",
24+
"ButtonConfig"
25+
]
426
}

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
"src.primitives.jquery.compile": "compiler.jar --js=min\\primitives.jquery.latest.js --js_output_file=min\\primitives.jquery.min.js",
1010
"src.tests.merge": "node merge.js src.tests\\src.tests.json",
1111
"merge": "yarn src.primitives.merge && yarn src.primitives.compile && yarn src.primitives.jquery.merge && yarn src.primitives.jquery.compile && yarn src.tests.merge",
12-
"reference": "node --nolazy --inspect-brk=9229 reference.js reference.json"
12+
"apireference": "node --nolazy --inspect-brk=9229 apireference.js apireference.json"
1313
},
1414
"dependencies": {
1515
"eslint": "^5.15.1"
@@ -19,4 +19,4 @@
1919
"type": "git",
2020
"url": "https://github.com/BasicPrimitives/javascript"
2121
}
22-
}
22+
}

src.primitives/Controls/FamDiagram/Control.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Creates JavaScript Family Chart Control
3-
*
3+
* @class Control
44
* @param {object} element Reference to placeholder `div` element in the DOM. The control renders diagram content
55
* inside of that div element and adds events listeners.
66
* @param {Config} options Family Chart Configuration object

src.primitives/Controls/FamDiagram/configs/BackgroundAnnotationConfig.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
/*
2-
Class: primitives.famdiagram.BackgroundAnnotationConfig
3-
Consider background annotation as another way to highlight some items in diagram.
4-
In order to use it you have to create instances of this class and populate annotation collection.
5-
Background annotation is drawn as rectangular area offset around annotated item.
6-
If two items backgrounds overlap each other they are merged into one background area.
71

8-
See Also:
9-
<primitives.famdiagram.Config.annotations>
10-
*/
2+
/**
3+
* @class BackgroundAnnotationConfig
4+
* @classdesc Consider background annotation as another way to highlight some items in diagram.
5+
* In order to use it you have to create instances of this class and populate annotation collection.
6+
* Background annotation is drawn as rectangular area offset around annotated item.
7+
* If two items backgrounds overlap each other they are merged into one background area.
8+
*
9+
* @param {object} arg0 Object properties.
10+
*/
1111
primitives.famdiagram.BackgroundAnnotationConfig = function (arg0) {
1212
var property;
1313

src.primitives/Controls/FamDiagram/configs/Config.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -617,7 +617,7 @@ primitives.famdiagram.Config = function (name) {
617617
* Templates are HTML fragments containing layout and styles used to render diagram nodes.
618618
* They are defined with a named configuration objects. See `templates` property of control's configuration object.
619619
*
620-
* @type {string|undefined}
620+
* @type {string}
621621
*/
622622
this.defaultCalloutTemplateName = null;
623623

@@ -743,14 +743,14 @@ primitives.famdiagram.Config = function (name) {
743743
this.groupTitleColor = primitives.common.Colors.RoyalBlue;
744744

745745
/**
746-
* Group titles font weight: normal | bold
746+
* Group titles font weight: normal, bold
747747
*
748748
* @type {string}
749749
*/
750750
this.groupTitleFontWeight = "normal";
751751

752752
/**
753-
* Group titles font style: normal | italic
753+
* Group titles font style: normal, italic
754754
*
755755
* @type {string}
756756
*/
@@ -855,14 +855,14 @@ primitives.famdiagram.Config = function (name) {
855855

856856
/**
857857
* Labels font weight
858-
* Font weight: normal | bold
858+
* Font weight: normal, bold
859859
*
860860
* @type {string}
861861
*/
862862
this.labelFontWeight = "normal";
863863

864864
/**
865-
* Labels font style. Font style: normal | italic
865+
* Labels font style. Font style: normal, italic
866866
*
867867
* @type {string}
868868
*/

src.primitives/Controls/FamDiagram/configs/ItemConfig.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ primitives.famdiagram.ItemConfig = function (arg0, arg1, arg2, arg3, arg4) {
2222

2323
/**
2424
* Parents items ids. If this collection is empty then item considered as a root item.
25-
* @type {string[] | undefined}
25+
* @type {string[]}
2626
*/
2727
this.parents = [];
2828

2929
/**
3030
* Spouses items ids. The nodes of this collection create fake invisible child node,
3131
* so all of them are being connected with common child connection line.
32-
* @type {string[] | undefined}
32+
* @type {string[]}
3333
*/
3434
this.spouses = [];
3535

@@ -41,7 +41,7 @@ primitives.famdiagram.ItemConfig = function (arg0, arg1, arg2, arg3, arg4) {
4141
* If this property set to null, family layout algorithm will try to choose elements order via placing connected
4242
* nodes as close to each other as posible.
4343
*
44-
* @type {string | undefined}
44+
* @type {string}
4545
*/
4646
this.relativeItem = null;
4747

src.primitives/Controls/FamDiagram/configs/TemplateConfig.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ primitives.famdiagram.TemplateConfig = function () {
159159
this.cursorBorderWidth = 2;
160160

161161
/**
162-
* Highlight Template.
162+
* Cursor Template.
163163
*
164164
* The control calls `onCursorRender` callback function when specific node cursor needs to be rendered with this template.
165165
*

src.primitives/Controls/FamDiagram/events/EventArgs.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
/**
22
* @class EventArgs
3+
*
4+
* Context object
35
*/
4-
primitives.orgdiagram.EventArgs = function () {
6+
primitives.famdiagram.EventArgs = function () {
57
/**
68
* Current item
79
*

src.primitives/Controls/OrgDiagram/BaseControl.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
/**
2+
* JavaScript Abstract Control
3+
* @class BaseControl
4+
*/
15
primitives.orgdiagram.BaseControl = function (element, options, taskManagerFactory, eventArgsFactory, templates) {
26
var _data = {
37
name: "orgdiagram",

0 commit comments

Comments
 (0)