Skip to content

Commit b7d32fc

Browse files
committed
test: Add some JSDocs links to related methods in TestHelpers.ts, for easy navigation
1 parent b219cd4 commit b7d32fc

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

tests/TestingTools/TestHelpers.ts

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
import { Task } from '../../src/Task/Task';
22
import { TaskLocation } from '../../src/Task/TaskLocation';
33

4+
/**
5+
* @see fromLines
6+
* @see toLine
7+
*/
48
export function fromLine({
59
line,
610
path = '',
@@ -17,6 +21,11 @@ export function fromLine({
1721
})!;
1822
}
1923

24+
/**
25+
* @see fromLine
26+
* @see createTasksFromMarkdown
27+
* @see toLines
28+
*/
2029
export function fromLines({
2130
lines,
2231
path = '',
@@ -29,14 +38,25 @@ export function fromLines({
2938
return lines.map((line) => fromLine({ line, path, precedingHeader }));
3039
}
3140

41+
/**
42+
* @see toLines
43+
* @see fromLine
44+
*/
3245
export function toLine(task: Task) {
3346
return task.toFileLineString();
3447
}
3548

49+
/**
50+
* @see toLine
51+
* @see fromLines
52+
*/
3653
export function toLines(tasks: Task[]) {
3754
return tasks.map((task) => toLine(task));
3855
}
3956

57+
/**
58+
* @see fromLines
59+
*/
4060
export function createTasksFromMarkdown(tasksAsMarkdown: string, path: string, precedingHeader: string): Task[] {
4161
const taskLines = tasksAsMarkdown.split('\n');
4262
const tasks: Task[] = [];

0 commit comments

Comments
 (0)