update readme

[clo] / src / libclo / breakLines.ts

diff --git a/src/libclo/breakLines.ts b/src/libclo/breakLines.ts
index 7ab8c0d70bf0c68cd951a3feb89b3536722b345b..f3f6a3c856d4765f12567409280db65161f5ea59 100644 (file)
--- a/src/libclo/breakLines.ts
+++ b/src/libclo/breakLines.ts
@@ -49,7 +49,12 @@ export class BreakLineAlgorithm {
             return item.width;
         }
     }
-
+    
+    /**segement node of one paragraph into lines. 
+     * @args items: nodes of a line
+     * @args linewidth: the line width
+     * @returns segmented nodes into lines
+    */
     segmentedNodes(items : BoxesItem[], lineWidth : number) : BoxesItem[][]{
 
         let lineWidthFixed = lineWidth;