update readme

[clo] / src / libclo / breakLines.js

diff --git a/src/libclo/breakLines.js b/src/libclo/breakLines.js
index 14a7836178190690f79c86f462067fa58022a4aa..c7319be170a726b1e7d95b78e2bef42a1f1aa272 100644 (file)
--- a/src/libclo/breakLines.js
+++ b/src/libclo/breakLines.js
@@ -34,6 +34,11 @@ 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, lineWidth) {
         let lineWidthFixed = lineWidth;
         this.totalCost(items, lineWidthFixed);