Merge pull request #551 from ztyyLV/Jackson-branch

Update Addon_PDF.md

Author: ztyyLV

info/api/Addon_PDF.md

@@ -23,16 +23,16 @@ permalink: /info/api/Addon_PDF.html
 
 ## GetConvertMode
 
+Return the convert mode.
+
 **Syntax**
 
 ```typescript
-/**
- * Return the convert mode.
- */
 GetConvertMode(): number;
 ```
 
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -59,18 +59,16 @@ GetConvertMode(): number;
 
 ## IsModuleInstalled
 
+Return whether the PDF module has been installed.
+
 **Syntax**
 
 ```typescript
-/**
-
-* Return whether the PDF module has been installed.
-
-*/
 IsModuleInstalled(): boolean;
 ```
 
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -97,17 +95,20 @@ IsModuleInstalled(): boolean;
 
 ## IsTextBasedPDF
 
+Detect whether a local PDF file is text based or not.
+
 **Syntax**
 
 ```typescript
-/**
- * Detect whether a local PDF file is text based or not.
- * @path Specify the path of the PDF file.
- */
 IsTextBasedPDF(path: string): boolean;
 ```
 
+**Parameters**
+
+`path`: Specify the path of the PDF file.
+
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -134,28 +135,20 @@ IsTextBasedPDF(path: string): boolean;
 
 ## SetConvertMode
 
+Set the convert mode.
+
 **Syntax**
 
 ```typescript
-/**
- * Set the convert mode.
- * @param mode Specify the mode. The default value is 3 (Dynamsoft.DWT.EnumDWT_ConvertMode.CM_AUTO)
- */
 SetConvertMode(mode: Dynamsoft.DWT.EnumDWT_ConvertMode | number): boolean;
 ```
 
-**Usage notes**
-
-There are four conversion modes
-
-- CM_RENDERALL (1): All the content in the target PDF file will be rasterized.
-- CM_IMAGEONLY (2): The PDF Rasterizer is turned off.
-- CM_AUTO (3): The library automatically detect whether a file needs to be rasterized or not and then process the file accordingly.
-- CM_RENDERALLWITHANNOTATION (4): Support loading PDF file with annotation. 
+**Parameters**
 
-Use this method before you import a PDF into the viewer with methods such as <a href="{{site.info}}api/WebTwain_IO.html#loadimage" target="_blank">`LoadImage()`</a> , <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`HTTPDownload()`</a> and <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`FTPDownload()`</a>.
+`mode`: Specify the mode. The default value is 3 (Dynamsoft.DWT.EnumDWT_ConvertMode.CM_AUTO)
 
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -178,25 +171,35 @@ Use this method before you import a PDF into the viewer with methods such as <a
 </table>
 </div>
 
+**Usage notes**
+
+There are four conversion modes
+
+- CM_RENDERALL (1): All the content in the target PDF file will be rasterized.
+- CM_IMAGEONLY (2): The PDF Rasterizer is turned off.
+- CM_AUTO (3): The library automatically detect whether a file needs to be rasterized or not and then process the file accordingly.
+- CM_RENDERALLWITHANNOTATION (4): Support loading PDF file with annotation. 
+
+Use this method before you import a PDF into the viewer with methods such as <a href="{{site.info}}api/WebTwain_IO.html#loadimage" target="_blank">`LoadImage()`</a> , <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`HTTPDownload()`</a> and <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`FTPDownload()`</a>.
+
 ---
 
 ## SetPassword
 
+Set the password for reading encrypted PDF files.
+
 **Syntax**
 
 ```typescript
-/**
- * Set the password for reading encrypted PDF files.
- * @param password Specify the password.
- */
 SetPassword(password: string): boolean;
 ```
 
-**Usage notes**
+**Parameters**
 
-Use this method before you import a PDF into the viewer with methods such as <a href="{{site.info}}api/WebTwain_IO.html#loadimage" target="_blank">`LoadImage()`</a> , <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`HTTPDownload()`</a> and <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`FTPDownload()`</a>.
+`password`: Specify the password.
 
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -218,27 +221,29 @@ Use this method before you import a PDF into the viewer with methods such as <a
 
 </table>
 </div>
+
+**Usage notes**
+
+Use this method before you import a PDF into the viewer with methods such as <a href="{{site.info}}api/WebTwain_IO.html#loadimage" target="_blank">`LoadImage()`</a> , <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`HTTPDownload()`</a> and <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`FTPDownload()`</a>.
+
 ---
 
 ## SetResolution
 
+Set the resolution for rasterizing.
+
 **Syntax**
 
 ```typescript
-/**
- * Set the resolution for rasterizing.
- * @param resolution Specify the resolution.
- */
 SetResolution(resolution: number): boolean;
 ```
 
-**Usage notes**
-
-The default resolution for the conversion is 200. We recommend that you set a value smaller than 300, otherwise it might slow down the program or cause the process to fail.
+**Parameters**
 
-Use this method before you import a PDF into the viewer with methods such as <a href="{{site.info}}api/WebTwain_IO.html#loadimage" target="_blank">`LoadImage()`</a> , <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`HTTPDownload()`</a> and <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`FTPDownload()`</a>.
+`resolution`: Specify the resolution.
 
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -261,17 +266,21 @@ Use this method before you import a PDF into the viewer with methods such as <a
 </table>
 </div>
 
+**Usage notes**
+
+The default resolution for the conversion is 200. We recommend that you set a value smaller than 300, otherwise it might slow down the program or cause the process to fail.
+
+Use this method before you import a PDF into the viewer with methods such as <a href="{{site.info}}api/WebTwain_IO.html#loadimage" target="_blank">`LoadImage()`</a> , <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`HTTPDownload()`</a> and <a href="{{site.info}}api/WebTwain_IO.html#httpdownload" target="_blank">`FTPDownload()`</a>.
+
 ---
 
 ## Write.Setup()
 
+Set up the PDF writing engine.
+
 **Syntax**
 
 ```typescript
-/**
- * Set up the PDF writing engine.
- * @param settings Configures how the PDF is generated.
- */
 Write.Setup(settings: PDFWSettings): void;
 
 interface PDFWSettings {
@@ -333,13 +342,12 @@ interface PDFWSettings {
 }
 ```
 
-**Usage notes**
+**Parameters**
 
-Use this method before you create a PDF with methods such as <a href="{{site.info}}api/WebTwain_IO.html#httpupload" target="_blank">`HTTPUpload()`</a>, <a href="{{site.info}}api/WebTwain_IO.html#saveaspdf" target="_blank">`SaveAsPDF()`</a>, and <a href="{{site.info}}api/WebTwain_IO.html#saveallaspdf" target="_blank">`SaveAllAsPDF()`</a>
-
-Only the core module license is required to use this method.
+`settings`: Configures how the PDF is generated.
 
 **Availability**
+
 <div class="availability">
 <table>
 
@@ -361,3 +369,9 @@ Only the core module license is required to use this method.
 
 </table>
 </div>
+
+**Usage notes**
+
+Use this method before you create a PDF with methods such as <a href="{{site.info}}api/WebTwain_IO.html#httpupload" target="_blank">`HTTPUpload()`</a>, <a href="{{site.info}}api/WebTwain_IO.html#saveaspdf" target="_blank">`SaveAsPDF()`</a>, and <a href="{{site.info}}api/WebTwain_IO.html#saveallaspdf" target="_blank">`SaveAllAsPDF()`</a>
+
+Only the core module license is required to use this method.