jsdoc: Document ListItem.identicalTo()

ilandikov · Oct 18, 2024 · 3d51640 · 3d51640
1 parent aeed58c
commit 3d51640
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/Task/ListItem.ts b/src/Task/ListItem.ts
@@ -49,6 +49,15 @@ export class ListItem {
  return this.parent === null;
  }
 
+ /**
+ * Compare all the fields in another ListItem, to detect any differences from this one.
+ *
+ * If any field is different in any way, it will return false.
+ *
+ * @note Use {@link Task.identicalTo} to compare {@link Task} objects.
+ *
+ * @param other - if this is in fact a {@link Task}, the result of false.
+ */
  identicalTo(other: ListItem) {
  if (this.constructor.name !== other.constructor.name) {
  return false;