update docs

2023-11-22 20:10:42 +08:00 · 2023-11-22 20:10:42 +08:00 · f33568e79c
commit f33568e79c
parent 9548c51651
76 changed files with 316 additions and 941 deletions
--- a/README.md
+++ b/README.md
@ -72,5 +72,8 @@
 ```

 ## How to generate documents
- - `typedoc /path/to/index.js [/path/to/index2.js ...]`
-the generated page will be stored in `/src`.
+ - `typedoc /path/to/src1 [/path/to/another/src/or/.js ...]`
+the generated page will be stored in `/docs`.
+
+store the documents
+ - `rsync /path/to/docs host@/var/www/docs`
--- a/docs/assets/highlight.css
+++ b/docs/assets/highlight.css
@ -1,14 +1,14 @@
 :root {
    --light-hl-0: #000000;
-    --dark-hl-0: #C8C8C8;
-    --light-hl-1: #000000;
-    --dark-hl-1: #D4D4D4;
-    --light-hl-2: #001080;
-    --dark-hl-2: #9CDCFE;
-    --light-hl-3: #A31515;
-    --dark-hl-3: #CE9178;
-    --light-hl-4: #0070C1;
-    --dark-hl-4: #4FC1FF;
+    --dark-hl-0: #D4D4D4;
+    --light-hl-1: #001080;
+    --dark-hl-1: #9CDCFE;
+    --light-hl-2: #0070C1;
+    --dark-hl-2: #4FC1FF;
+    --light-hl-3: #000000;
+    --dark-hl-3: #C8C8C8;
+    --light-hl-4: #A31515;
+    --dark-hl-4: #CE9178;
    --light-hl-5: #008000;
    --dark-hl-5: #6A9955;
    --light-hl-6: #0000FF;
--- a/docs/assets/navigation.js
+++ b/docs/assets/navigation.js
@ -1 +1 @@
-window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52YXXObOBRA/4ufM9s223Z38+Y4JHEbYyZm28xkOh4Fy0a1kBghUrs7/e8rQIBAcMX0KQn36OgD6V6R5/9mEp/k7GoWIfaKZhezFMlY/ZnwXU5x9qZ8/EcsE6piR8J2s6vLi1kUE7oTmM2unhvBLWdyI88UtxLM8qRWNOGu7O9fF40hVD++YnKI5bCijY87FpS3jQmTWOxR1MxDRXtz+fCx23jBkwSpCOjQEKQqxtpbDcvUMJBor9YtUIJg46MEB4gIwGjDkDq4ub3hUZ5gZiy4PKeNzgB6nrf//PXuw6U1X4FR8i8jI7ou4zLu6w0T8uLXVrnPWSQJZ+akDbDr/fjeUKa5LMYwrtKApfhmSGIk9i/5z5/2Wakjk45LDYc4GxxQKzNAcGDqGT7ZoyofTxsSpukNzqLW8YoEQS+GRRNd3Z/ma0sFV/sxm4vD69C0Ko8BgVOi5CUyD3Q9p+r5pEndEIHLvvs5RTua+MScElGUZe0QrIzy7tJses1Pg8dVt1Zh6IBeq7NyDDgxd/+ApKHA3Kb2kWM0GoEst0LlFYemZiDP/R3Nh1OjlpQAuDb8hLOlxEk/17RLW8VdeWb+frv0t8HT0K7XrhoBtn30/fh6TXl0zJbsER/Mg2jpLNbhLRmV1tUaMYfWRAHrDu9RTmX5pnpVytJarNs7UPzGtCM1sLsGiEY5RRKXFwCyk/F975bQ5pd6LUaaAMVhrMk8P/1GR6oV0NeeUPWGvCSVZ1UQCTsAPVgs4I3PaYzZLRedlGUpTcxpC4+hwNhpqzCo+MqQB9BSVgBgyNIiQ4S8THhpNy1aNhsGzZTIxafPX0ChZgCP/MEfscwFUx37+AclDFq4AXpCNXzzUszoQcHZWGHctsikGnld43N64ILI2Eiq3Xpnmu1WdiU0h58ikWFhj7l6PmmgIT9i9pmY9/OqmGtHEx8v5rK3nauiodvLgU1sV4zF2g89PxxKbtqjCSCnLVfB+hFSVIDT4HlOh+c5LRunZAM4/HW4nUNzqQCnYRt6T25NSQGu4HF9B0iKMNB6492t4HerCdCxWi7WD2sftGgG8FB8Ms+L5SjjQHueS/VB45mnxXI0jNNzj5FbVEBO04rsdsN3g46rwgAbSlN6Lr7F8XAl0DYTA3K3xtRNdIqtxFy2ZZJy4ZRV1DRXNk2WuWw+l/PRb2HT14AuY4AmjK6EJpm+qnqitsG0FbRbuPrY4MOUXaMxty0hC07Nb8wxnwadxuL24j84fRXmsk150Y53TJj+30jIx66D2tYjoduSCof80waQ1Qh4L0p3+xViJC3v4QP3CzPcq+2/vv0PRTFWxwIVAAA="
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA52XUW/aMBDHvwvP1bZ2bbf1jUJoaUuIIFsrVRVygyEejh0lDgVN++4ziQlOnJyjPZX6/vezffbdOa9/egLvRO+mFyC2Rb2zXoxEKP+N+DKjOP2cD38KRUSlbUPYsndzcdYLQkKXCWa9m9cSMOJMzMWe4hMEsyw6IkpzFfb971lJ8OWfZ0zWoWhGnOztjAHlJ2fCBE5WKCj3Ia21vVxdV50HPIqQtIAMJYJQh7XWomGQSg0EWsm4eRLgzV0UYQ+RBCCaYgjtDUdDHmQRZlrAxT4ucZqgxvny49v51YWx3wSj6CcjLbiqxkZcHS+Mzw8/T8hVxgJBONM3rQmr3OtLDRln4rCGdpQSGIg3DSLH8M5MlHy4U6KEmMZDnAYnxhYlBL1rFKWo4r7q0YkTLo897SfrbdN2Co4mArdEyXug581xT8V4p00NSYLzueupqxilvWPqBhSl6WkJRuKeX+iut3zXmBXKW5qhPLiVV3LjcaJfsgZIqQJLSIgSy2qUBKKMEpm+FsxRA3Hu72jWXIEUJBeAseE7nI4FjuopfQptYbelc/9yMXYX3kvTrVesowS49sHvzfaW8mCTjtkMr/VENHCG1sLNNbJ6yhgxC1aXAtQlXqGMivykas3AwBpaO7ehx7RhW1pNNQaIBhlFAud9lixFeF9rxqf6coxFiwtQg9tc+tnuPyaSXsBcK0LlCTlRLPay7xC2BmYwtAA33MchZiOeVEqWgdRlVpq/8ROMrbRCBvU44XMPCmUhAAhpfKgQPs8LXlwtiwbNFINkSsTg4fEXCFQagCM++AyLLGFyYhd/UMKgwDWowW4YoyTF2ivr2A2L8U7d0OcbzB6J/o4suqFilPb2bihq96GouspfNNwCs+QOpq7vuH5TdVAcpQCKwnjiTWcQohBYCY5jZTiOlTK3QuYAw536iz60l0JgJSx858WOyVUAy5tN7wDIwQx4z527CXy2SgEyJuPB9GnqghSlATgU7/R8MRi5HfDnmZAPb0fPFoNRaqyce4zsoIPISpqQ5bK5uVZYhQygoTim+8M3I24upYqmy4Dip2TyKdeFlststHEU88QKK1TdWGk3WGqjuVz0W7/ZdF4ptBE91GF1uagT6ZmIUF6DbhE0PWxzzPG6y61RMjstIgNO9Y+0Np4SWomH9u8+WXmFzEbrctCWMyZMfcP7vO09pWg1JfTckGafP8wB2FHS8LB4+webpy2EZBMAAA=="
--- a/docs/assets/search.js
+++ b/docs/assets/search.js
--- a/docs/classes/libclo.Clo.html
+++ b/docs/classes/libclo.Clo.html
--- a/docs/classes/libclo_breakLines.BreakLineAlgorithm.html
+++ b/docs/classes/libclo_breakLines.BreakLineAlgorithm.html
--- a/docs/enums/canva.FontStyle.html
+++ b/docs/enums/canva.FontStyle.html
--- a/docs/enums/canva.TextWeight.html
+++ b/docs/enums/canva.TextWeight.html
--- a/docs/enums/libclo.Direction.html
+++ b/docs/enums/libclo.Direction.html
--- a/docs/enums/parser.TokenKind.html
+++ b/docs/enums/parser.TokenKind.html
--- a/docs/functions/canva.fontStyleTofont.html
+++ b/docs/functions/canva.fontStyleTofont.html
--- a/docs/functions/canva.putText.html
+++ b/docs/functions/canva.putText.html
--- a/docs/functions/harfbuzz.harfbuzzTest.html
+++ b/docs/functions/harfbuzz.harfbuzzTest.html
--- a/docs/functions/index.processArgv.html
+++ b/docs/functions/index.processArgv.html
--- a/docs/functions/libclo.calculateTextWidthHeight.html
+++ b/docs/functions/libclo.calculateTextWidthHeight.html
--- a/docs/functions/libclo.calculateTextWidthHeightAux.html
+++ b/docs/functions/libclo.calculateTextWidthHeightAux.html
--- a/docs/functions/libclo.filterEmptyString.html
+++ b/docs/functions/libclo.filterEmptyString.html
--- a/docs/functions/libclo.hyphenForClo.html
+++ b/docs/functions/libclo.hyphenForClo.html
--- a/docs/functions/libclo.hyphenTkTree.html
+++ b/docs/functions/libclo.hyphenTkTree.html
--- a/docs/functions/libclo.ptToPx.html
+++ b/docs/functions/libclo.ptToPx.html
--- a/docs/functions/libclo.spacesToBreakpoint.html
+++ b/docs/functions/libclo.spacesToBreakpoint.html
--- a/docs/functions/libclo.splitCJKV.html
+++ b/docs/functions/libclo.splitCJKV.html
--- a/docs/functions/libclo.twoReturnsToNewline.html
+++ b/docs/functions/libclo.twoReturnsToNewline.html
--- a/docs/functions/parser.applyComment.html
+++ b/docs/functions/parser.applyComment.html
--- a/docs/functions/parser.applyContent.html
+++ b/docs/functions/parser.applyContent.html
--- a/docs/functions/parser.applyImport.html
+++ b/docs/functions/parser.applyImport.html
--- a/docs/functions/parser.applyImports.html
+++ b/docs/functions/parser.applyImports.html
--- a/docs/functions/parser.applyNotAtText.html
+++ b/docs/functions/parser.applyNotAtText.html
--- a/docs/functions/parser.applyParts.html
+++ b/docs/functions/parser.applyParts.html
--- a/docs/functions/parser.applyPartsWithoutImport.html
+++ b/docs/functions/parser.applyPartsWithoutImport.html
--- a/docs/functions/parser.applySegment.html
+++ b/docs/functions/parser.applySegment.html
--- a/docs/functions/parser.applySemiColon.html
+++ b/docs/functions/parser.applySemiColon.html
--- a/docs/functions/parser.applySpaceNL.html
+++ b/docs/functions/parser.applySpaceNL.html
--- a/docs/functions/parser.applyText.html
+++ b/docs/functions/parser.applyText.html
--- a/docs/functions/parser.inputTextToTree.html
+++ b/docs/functions/parser.inputTextToTree.html
--- a/docs/functions/parser.treeToJS.html
+++ b/docs/functions/parser.treeToJS.html
--- a/docs/index.html
+++ b/docs/index.html
--- a/docs/interfaces/canva.Clo.html
+++ b/docs/interfaces/canva.Clo.html
--- a/docs/interfaces/canva.CloCommand.html
+++ b/docs/interfaces/canva.CloCommand.html
--- a/docs/interfaces/canva.TextStyle.html
+++ b/docs/interfaces/canva.TextStyle.html
--- a/docs/interfaces/canva.fontPathPSNamePair.html
+++ b/docs/interfaces/canva.fontPathPSNamePair.html
--- a/docs/interfaces/libclo.Box.html
+++ b/docs/interfaces/libclo.Box.html
--- a/docs/interfaces/libclo.BreakPoint.html
+++ b/docs/interfaces/libclo.BreakPoint.html
--- a/docs/interfaces/libclo.CharBox.html
+++ b/docs/interfaces/libclo.CharBox.html
--- a/docs/interfaces/libclo.FrameBox.html
+++ b/docs/interfaces/libclo.FrameBox.html
--- a/docs/interfaces/libclo.HGlue.html
+++ b/docs/interfaces/libclo.HGlue.html
--- a/docs/modules/canva.html
+++ b/docs/modules/canva.html
--- a/docs/modules/harfbuzz.html
+++ b/docs/modules/harfbuzz.html
--- a/docs/modules/index.html
+++ b/docs/modules/index.html
--- a/docs/modules/libclo.html
+++ b/docs/modules/libclo.html
--- a/docs/modules/libclo_breakLines.html
+++ b/docs/modules/libclo_breakLines.html
--- a/docs/modules/parser.html
+++ b/docs/modules/parser.html
--- a/docs/modules/pdfManipulate.html
+++ b/docs/modules/pdfManipulate.html
--- a/docs/types/canva.PDFDocument.html
+++ b/docs/types/canva.PDFDocument.html
--- a/docs/types/canva.TextStreamUnit.html
+++ b/docs/types/canva.TextStreamUnit.html
--- a/docs/types/libclo.BoxesItem.html
+++ b/docs/types/libclo.BoxesItem.html
--- a/docs/types/parser.tkTree.html
+++ b/docs/types/parser.tkTree.html
--- a/docs/variables/index.helpDesc.html
+++ b/docs/variables/index.helpDesc.html
--- a/docs/variables/libclo.A4_IN_PX.html
+++ b/docs/variables/libclo.A4_IN_PX.html
--- a/docs/variables/libclo.cjkvBlocksInRegex.html
+++ b/docs/variables/libclo.cjkvBlocksInRegex.html
--- a/docs/variables/libclo.cjkvRegexPattern.html
+++ b/docs/variables/libclo.cjkvRegexPattern.html
--- a/docs/variables/libclo.defaultFrameStyle.html
+++ b/docs/variables/libclo.defaultFrameStyle.html
--- a/docs/variables/libclo.defaultTextStyle.html
+++ b/docs/variables/libclo.defaultTextStyle.html
--- a/docs/variables/parser.CONTENT.html
+++ b/docs/variables/parser.CONTENT.html
--- a/docs/variables/parser.IMPORT.html
+++ b/docs/variables/parser.IMPORT.html
--- a/docs/variables/parser.IMPORTEE.html
+++ b/docs/variables/parser.IMPORTEE.html
--- a/docs/variables/parser.IMPORTS.html
+++ b/docs/variables/parser.IMPORTS.html
--- a/docs/variables/parser.NOT_AT.html
+++ b/docs/variables/parser.NOT_AT.html
--- a/docs/variables/parser.NOT_AT_TEXT.html
+++ b/docs/variables/parser.NOT_AT_TEXT.html
--- a/docs/variables/parser.PROG.html
+++ b/docs/variables/parser.PROG.html
--- a/docs/variables/parser.SEGMENT.html
+++ b/docs/variables/parser.SEGMENT.html
--- a/docs/variables/parser.SEMICOLON.html
+++ b/docs/variables/parser.SEMICOLON.html
--- a/docs/variables/parser.lexer.html
+++ b/docs/variables/parser.lexer.html
--- a/docs/variables/parser.outputEnd.html
+++ b/docs/variables/parser.outputEnd.html
--- a/docs/variables/parser.outputHead.html
+++ b/docs/variables/parser.outputHead.html
--- a/docs/variables/parser.outputMiddle.html
+++ b/docs/variables/parser.outputMiddle.html