docs: add description

schoero · Nov 16, 2023 · 082d9ed · 082d9ed
1 parent 99b1c95
commit 082d9ed
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 12 deletions.
diff --git a/docs/bundle/index.md b/docs/bundle/index.md
@@ -388,7 +388,7 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L63C0)
 
 #### Type alias: pdf.PDFBorderColor
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L90C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L91C0)  
 
 ##### Type
 
@@ -407,11 +407,15 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L90C0)
   - vertical [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
   - horizontal [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
 
+##### Description
+
+Can be used to set the color of the border of a table, row or column.  
+
 <br/>
 
 #### Type alias: pdf.PDFBorderWidth
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L95C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L97C0)  
 
 ##### Type
 
@@ -430,11 +434,15 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L95C0)
   - vertical [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
   - horizontal [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
 
+##### Description
+
+Can be used to set the width of the border of a table, row or column.  
+
 <br/>
 
 #### Type alias: pdf.PDFPadding
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L100C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L103C0)  
 
 ##### Type
 
@@ -453,11 +461,15 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L100C0)
   - vertical [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
   - horizontal [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
 
+##### Description
+
+Can be used to set the padding of a table cell.  
+
 <br/>
 
 #### Class: pdf.Table
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L154C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L157C0)  
 
 ##### Description
 
@@ -507,7 +519,7 @@ pdf.end();
 
 ##### Constructor: new pdf.Table(data)
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L161C2)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L164C2)  
 
 ###### Parameter
 
@@ -527,7 +539,7 @@ Creates a new Table instance.
 
 `public`  
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L185C2)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L188C2)  
 
 ###### Parameters
 

diff --git a/docs/pdf/index.md b/docs/pdf/index.md
@@ -239,7 +239,7 @@ Attaches the Swiss QR Code to a PDF document.
 
 ### Class: Table
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L154C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L157C0)  
 
 #### Description
 
@@ -289,7 +289,7 @@ pdf.end();
 
 #### Constructor: new Table(data)
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L161C2)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L164C2)  
 
 ##### Parameter
 
@@ -309,7 +309,7 @@ Creates a new Table instance.
 
 `public`  
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L185C2)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L188C2)  
 
 ##### Parameters
 
@@ -334,7 +334,7 @@ every row that no longer fits on a page.
 
 ### Type alias: PDFBorderColor
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L90C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L91C0)  
 
 #### Type
 
@@ -353,11 +353,15 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L90C0)
   - vertical [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
   - horizontal [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
 
+#### Description
+
+Can be used to set the color of the border of a table, row or column.  
+
 <br/>
 
 ### Type alias: PDFBorderWidth
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L95C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L97C0)  
 
 #### Type
 
@@ -376,11 +380,15 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L95C0)
   - vertical [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
   - horizontal [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
 
+#### Description
+
+Can be used to set the width of the border of a table, row or column.  
+
 <br/>
 
 ### Type alias: PDFPadding
 
-Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L100C0)  
+Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L103C0)  
 
 #### Type
 
@@ -399,6 +407,10 @@ Defined in: [src/pdf/table.ts](../../src/pdf/table.ts#L100C0)
   - vertical [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
   - horizontal [`number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)
 
+#### Description
+
+Can be used to set the padding of a table cell.  
+
 <br/>
 
 ### Interface: PDFTable

diff --git a/src/pdf/table.ts b/src/pdf/table.ts
@@ -87,16 +87,19 @@ export interface PDFColumn {
   width?: number;
 }
 
+/** Can be used to set the color of the border of a table, row or column. */
 export type PDFBorderColor =
   | string
   | [top?: string, right?: string, bottom?: string, left?: string]
   | [vertical?: string, horizontal?: string];
 
+/** Can be used to set the width of the border of a table, row or column. */
 export type PDFBorderWidth =
   | number
   | [top?: number, right?: number, bottom?: number, left?: number]
   | [vertical?: number, horizontal?: number];
 
+/** Can be used to set the padding of a table cell. */
 export type PDFPadding =
   | number
   | [top?: number, right?: number, bottom?: number, left?: number]