Skip to content

Commit 21ecf64

Browse files
Added bookmarks to reference
1 parent fec44bc commit 21ecf64

File tree

10 files changed

+109
-109
lines changed

10 files changed

+109
-109
lines changed

apireference.js

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -89,57 +89,57 @@ function create_index_md(title, {
8989
controlsclasses,
9090
pdfkitclasses
9191
}) {
92-
var result = "# " + title;
93-
result += "\r\n## [JavaScript Controls](javascriptcontrols.md)";
92+
var result = "### " + title;
93+
result += "\r\n#### [JavaScript Controls](javascriptcontrols.md)";
9494
result = controlsclasses.reduce((agg, annotation) => {
9595
let { namespace, name } = annotation;
9696
let key = [...namespace, name].join(".");
9797
agg += "\r\n* [" + key + "](javascriptcontrols.md#" + key + ")";
9898
return agg;
9999
}, result);
100-
result += "\r\n## [PDFKit Plugins](pdfkitplugins.md)";
100+
result += "\r\n#### [PDFKit Plugins](pdfkitplugins.md)";
101101
result = pdfkitclasses.reduce((agg, annotation) => {
102102
let { namespace, name } = annotation;
103103
let key = [...namespace, name].join(".");
104104
agg += "\r\n* [" + key + "](pdfkitplugins.md#" + key + ")";
105105
return agg;
106106
}, result);
107-
result += "\r\n## [Organizational Chart Configuration Objects](orgdiagram.md)";
107+
result += "\r\n#### [Organizational Chart Configuration Objects](orgdiagram.md)";
108108
result = orgdiagramclasses.reduce((agg, annotation) => {
109109
let { namespace, name } = annotation;
110110
let key = [...namespace, name].join(".");
111111
agg += "\r\n* [" + annotation.name + "](orgdiagram.md#" + key + ")";
112112
return agg;
113113
}, result);
114-
result += "\r\n## [Family Diagram Configuration Objects](famdiagram.md)";
114+
result += "\r\n#### [Family Diagram Configuration Objects](famdiagram.md)";
115115
result = famdiagramclasses.reduce((agg, annotation) => {
116116
let { namespace, name } = annotation;
117117
let key = [...namespace, name].join(".");
118118
agg += "\r\n* [" + annotation.name + "](famdiagram.md#" + key + ")";
119119
return agg;
120120
}, result);
121-
result += "\r\n## [Enumerations](enums.md)";
121+
result += "\r\n#### [Enumerations](enums.md)";
122122
result = enums.reduce((agg, annotation) => {
123123
let { namespace, name } = annotation;
124124
let key = [...namespace, name].join(".");
125125
agg += "\r\n* [" + annotation.name + "](enums.md#" + key + ")";
126126
return agg;
127127
}, result);
128-
result += "\r\n## [Structures](structures.md)";
128+
result += "\r\n#### [Structures](structures.md)";
129129
result = structures.reduce((agg, annotation) => {
130130
let { namespace, name } = annotation;
131131
let key = [...namespace, name].join(".");
132132
agg += "\r\n* [" + annotation.name + "](structures.md#" + key + ")";
133133
return agg;
134134
}, result);
135-
result += "\r\n## [Functions](functions.md)";
135+
result += "\r\n#### [Functions](functions.md)";
136136
result = functions.reduce((agg, annotation) => {
137137
let { namespace, name } = annotation;
138138
let key = [...namespace, name].join(".");
139139
agg += "\r\n* [" + annotation.name + "](functions.md#" + key + ")";
140140
return agg;
141141
}, result);
142-
result += "\r\n## [Algorithms](algorithms.md)";
142+
result += "\r\n#### [Algorithms](algorithms.md)";
143143
result = algorithms.reduce((agg, annotation) => {
144144
let { namespace, name } = annotation;
145145
let key = [...namespace, name].join(".");
@@ -184,7 +184,7 @@ function create_classes_md(title, classes) {
184184
return classes.reduce((agg, classAnnotation) => {
185185
let { name, description, namespace, constants, properties, functions, returns, params } = classAnnotation;
186186
let key = [...namespace, name].join(".");
187-
agg += '\r\n## <a name="' + key + '">' + name + '</a>';
187+
agg += '\r\n## <a name="' + key + '" id="' + key + '">' + name + '</a>';
188188
agg += "\r\n" + description;
189189
agg += "\r\n";
190190
agg += "\r\n `" + key + "` ";
@@ -229,7 +229,7 @@ function create_function_md({ name, namespace, signature, description, params, r
229229
var result = "\r\n"
230230
if (hasBookmark) {
231231
let key = [...namespace, name].join(".");
232-
result += '\r\n## <a name="' + key + '">' + name + '</a>';
232+
result += '\r\n## <a name="' + key + '" id="' + key + '">' + name + '</a>';
233233
} else {
234234
result += "\r\n `" + name + "(" + (signature != undefined ? signature.join(", ") : "") + ")` ";
235235
}
@@ -261,7 +261,7 @@ function create_enums_md(title, doc) {
261261
var result = "# " + title;
262262
return doc.enums.filter(item => item.ignore == undefined).reduce((agg, { name, description, namespace, items, type }) => {
263263
let key = [...namespace, name].join(".");
264-
agg += '\r\n## <a name="' + key + '">' + name + '</a>';
264+
agg += '\r\n## <a name="' + key + '" id="' + key + '">' + name + '</a>';
265265
agg += "\r\n" + description;
266266
agg += "\r\n";
267267
agg += "\r\n `" + [...namespace, name].join(".") + "` ";

apireference/algorithms.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Algorithms
2-
## <a name="primitives.common.family">family</a>
2+
## <a name="primitives.common.family" id="primitives.common.family">family</a>
33
Creates a family object
44

55
`primitives.common.family`
@@ -418,7 +418,7 @@ Validates internal data structure consitency of the family.
418418
| --- | --- | --- | --- |
419419
| `info` | object | `` | Optional validation object. |
420420

421-
## <a name="primitives.common.FamilyAlignment">FamilyAlignment</a>
421+
## <a name="primitives.common.FamilyAlignment" id="primitives.common.FamilyAlignment">FamilyAlignment</a>
422422
Creates family alignment data structure. This structure aligns horizontaly planar family of nodes.
423423

424424
`primitives.common.FamilyAlignment`
@@ -450,7 +450,7 @@ Returns horizontal node offset from left margin of the family daigram
450450
| --- | --- | --- | --- |
451451
| `nodeid` | string | `` | Family node id |
452452

453-
## <a name="primitives.common.FibonacciHeap">FibonacciHeap</a>
453+
## <a name="primitives.common.FibonacciHeap" id="primitives.common.FibonacciHeap">FibonacciHeap</a>
454454
Creates Fibonacci Heap structure
455455

456456
`primitives.common.FibonacciHeap`
@@ -532,7 +532,7 @@ Validates internal structure consistency.
532532
Returns: `boolean` - returns true if structure pass data consistency check.
533533

534534

535-
## <a name="primitives.common.graph">graph</a>
535+
## <a name="primitives.common.graph" id="primitives.common.graph">graph</a>
536536
Creates graph structure
537537

538538
`primitives.common.graph`
@@ -748,7 +748,7 @@ Callback function for iterating graphs nodes
748748
| --- | --- | --- | --- |
749749
| `to` | string | `` | The next neighbouring node id |
750750

751-
## <a name="primitives.common.LCA">LCA</a>
751+
## <a name="primitives.common.LCA" id="primitives.common.LCA">LCA</a>
752752
Creates Lowest Common Ancestor Structure for the given tree
753753

754754
`primitives.common.LCA`
@@ -778,7 +778,7 @@ Returns lowest common ancestor for the given pair of tree nodes
778778
| `from` | string | `` | The first tree node id |
779779
| `to` | string | `` | The second tree node id |
780780

781-
## <a name="primitives.common.LinkedHashItems">LinkedHashItems</a>
781+
## <a name="primitives.common.LinkedHashItems" id="primitives.common.LinkedHashItems">LinkedHashItems</a>
782782
Creates linked hash list collection.
783783

784784
`primitives.common.LinkedHashItems`
@@ -964,7 +964,7 @@ Validates internal data consistensy of the structure
964964
Returns: `boolean` - returns true if it pass validation
965965

966966

967-
## <a name="primitives.common.pile">pile</a>
967+
## <a name="primitives.common.pile" id="primitives.common.pile">pile</a>
968968
Creates pile structure used to sort and stack segments on top of each other so they occupy minimum number of rows.
969969

970970
`primitives.common.pile`
@@ -1013,7 +1013,7 @@ Callback function or iterating result offsets of the pile items in the stack.
10131013
| `context` | object | `` | The context of the pile item |
10141014
| `offset` | number | `` | Index of the pile item in the stack |
10151015

1016-
## <a name="primitives.common.QuadTree">QuadTree</a>
1016+
## <a name="primitives.common.QuadTree" id="primitives.common.QuadTree">QuadTree</a>
10171017
Creates Quad Tree data structure. It distributes points into equal quadrants. So it is equivalent to 2 dimensional binary search tree.
10181018

10191019
`primitives.common.QuadTree`
@@ -1078,7 +1078,7 @@ Validates internal data consistency of quad tree data structure
10781078
Returns: `boolean` - returns true if structure pass validation
10791079

10801080

1081-
## <a name="primitives.common.RMQ">RMQ</a>
1081+
## <a name="primitives.common.RMQ" id="primitives.common.RMQ">RMQ</a>
10821082
Creates range minimum query structure
10831083

10841084
`primitives.common.RMQ`
@@ -1119,7 +1119,7 @@ Returns index of minimum item for the given range of items
11191119
| `from` | number | `` | The left margin index |
11201120
| `to` | number | `` | The right margin index |
11211121

1122-
## <a name="primitives.common.SortedList">SortedList</a>
1122+
## <a name="primitives.common.SortedList" id="primitives.common.SortedList">SortedList</a>
11231123
Creates self-balancing binary search tree structure.
11241124

11251125
`primitives.common.SortedList`
@@ -1234,7 +1234,7 @@ Validate internal data consistency of the self-balancing binary search tree stru
12341234
Returns: `boolean` - returns true if structure pass validation
12351235

12361236

1237-
## <a name="primitives.common.SpatialIndex">SpatialIndex</a>
1237+
## <a name="primitives.common.SpatialIndex" id="primitives.common.SpatialIndex">SpatialIndex</a>
12381238
Create spatial index structure. It uses collection of sizes to distribute rectangles into buckets of similar size elements. Elements of the same bucket are aproximated to points. The search of rectangles is transformed to search of points within given range plus offset for maximum linear rectangle size.
12391239

12401240
`primitives.common.SpatialIndex`
@@ -1258,7 +1258,7 @@ Adds rectangle to spacial index
12581258
| --- | --- | --- | --- |
12591259
| `rect` | Rect | `` | Rectangle |
12601260

1261-
## <a name="primitives.common.tree">tree</a>
1261+
## <a name="primitives.common.tree" id="primitives.common.tree">tree</a>
12621262
Creates tree structure
12631263

12641264
`primitives.common.tree`
@@ -1690,7 +1690,7 @@ Callback function to return pairs of nodes
16901690
| `secondNodeid` | string | `` | Second node id |
16911691
| `secondParentId` | string | `` | Parent id of the second node |
16921692

1693-
## <a name="primitives.common.TreeLevels">TreeLevels</a>
1693+
## <a name="primitives.common.TreeLevels" id="primitives.common.TreeLevels">TreeLevels</a>
16941694
Creates Tree Levels structure. It is diagraming specific auxiliary structure that keeps tree nodes order level by level.
16951695

16961696
`primitives.common.TreeLevels`

0 commit comments

Comments
 (0)