Skip to content

Commit 30fb310

Browse files
committed
MOSOrderPositionFinder: add to docblocks
1 parent 2f45c2c commit 30fb310

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

SpeciesHelper/modules/MOSOrderPositionFinder.js

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,10 @@ export class MOSOrderPositionFinder {
9595
}
9696

9797
/**
98-
* Useful for testing. Returns all section positions.
98+
* Returns all section positions. Useful for testing.
99+
*
100+
* @param {string} wikicode
101+
* @return {Object} An object with section names as keys and their positions in the wikitext as values. 0 is the very beginning of the string. -1 means the section is not present.
99102
*/
100103
getAllSectionPositions( wikicode ) {
101104
this.wikitext = wikicode;
@@ -104,7 +107,10 @@ export class MOSOrderPositionFinder {
104107
}
105108

106109
/**
107-
* Useful for testing. Returns all section positions that exist (that aren't -1).
110+
* Returns all section positions that exist (that aren't -1). Useful for testing.
111+
*
112+
* @param {string} wikicode
113+
* @return {Object} An object with section names as keys and their positions in the wikitext as values. 0 is the very beginning of the string.
108114
*/
109115
getAllExistingSectionPositions( wikicode ) {
110116
this.wikitext = wikicode;

0 commit comments

Comments
 (0)