Added @module

hqtsm · Dec 7, 2024 · d50f325 · d50f325
1 parent 16a32f0
commit d50f325
Show file tree

Hide file tree

Showing 116 changed files with 696 additions and 0 deletions.
diff --git a/crc-10/atm.ts b/crc-10/atm.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-10/ATM
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-10/cdma2000.ts b/crc-10/cdma2000.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-10/CDMA2000
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-10/gsm.ts b/crc-10/gsm.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-10/GSM
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-11/flexray.ts b/crc-11/flexray.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-11/FLEXRAY
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-11/umts.ts b/crc-11/umts.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-11/UMTS
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-12/cdma2000.ts b/crc-12/cdma2000.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-12/CDMA2000
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-12/dect.ts b/crc-12/dect.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-12/DECT
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-12/gsm.ts b/crc-12/gsm.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-12/GSM
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-12/umts.ts b/crc-12/umts.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-12/UMTS
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-13/bbc.ts b/crc-13/bbc.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-13/BBC
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-14/darc.ts b/crc-14/darc.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-14/DARC
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-14/gsm.ts b/crc-14/gsm.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-14/GSM
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-15/can.ts b/crc-15/can.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-15/CAN
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-15/mpt1327.ts b/crc-15/mpt1327.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-15/MPT1327
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/arc.ts b/crc-16/arc.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/ARC
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/cdma2000.ts b/crc-16/cdma2000.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/CDMA2000
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/cms.ts b/crc-16/cms.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/CMS
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/dds-110.ts b/crc-16/dds-110.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/DDS-110
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/dect-r.ts b/crc-16/dect-r.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/DECT-R
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/dect-x.ts b/crc-16/dect-x.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/DECT-X
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/dnp.ts b/crc-16/dnp.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/DNP
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/en-13757.ts b/crc-16/en-13757.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/EN-13757
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/genibus.ts b/crc-16/genibus.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/GENIBUS
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/gsm.ts b/crc-16/gsm.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/GSM
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/ibm-3740.ts b/crc-16/ibm-3740.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/IBM-3740
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/ibm-sdlc.ts b/crc-16/ibm-sdlc.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/IBM-SDLC
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/iso-iec-14443-3-a.ts b/crc-16/iso-iec-14443-3-a.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/ISO-IEC-14443-3-A
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/kermit.ts b/crc-16/kermit.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/KERMIT
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/lj1200.ts b/crc-16/lj1200.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/LJ1200
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/m17.ts b/crc-16/m17.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/M17
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/maxim-dow.ts b/crc-16/maxim-dow.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/MAXIM-DOW
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/mcrf4xx.ts b/crc-16/mcrf4xx.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/MCRF4XX
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/modbus.ts b/crc-16/modbus.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/MODBUS
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/nrsc-5.ts b/crc-16/nrsc-5.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/NRSC-5
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/opensafety-a.ts b/crc-16/opensafety-a.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/OPENSAFETY-A
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/opensafety-b.ts b/crc-16/opensafety-b.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/OPENSAFETY-B
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/profibus.ts b/crc-16/profibus.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/PROFIBUS
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/riello.ts b/crc-16/riello.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/RIELLO
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/spi-fujitsu.ts b/crc-16/spi-fujitsu.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/SPI-FUJITSU
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**

diff --git a/crc-16/t10-dif.ts b/crc-16/t10-dif.ts
@@ -1,3 +1,9 @@
+/**
+ * @module
+ *
+ * CRC-16/T10-DIF
+ */
+
 import { crc, type CrcInterface } from '../crc.ts';
 
 /**