@@ -5,59 +5,55 @@ import metaconfig.annotation.ExtraName
55import metaconfig .generic .Surface
66
77/** @param openParenCallSite
8- * If true AND bin-packing is true, then call-site
9- * arguments won't be aligned by the opening
10- * parenthesis. For example, this output
11- * will be disallowed
8+ * If true AND bin-packing is true, then call-site arguments won't be aligned
9+ * by the opening parenthesis. For example, this output will be disallowed
1210 *
13- * function(a,
14- * b,
15- * c)
16- * @param openParenDefnSite Same as [[ openParenCallSite ]], except definition site.
17- * @param tokens The tokens to vertically align by. The "owner" is the
18- * scala.meta.Tree.getClass.getName of the deepest tree node
19- * that "owns" the token to align by.
11+ * function(a, b, c)
12+ * @param openParenDefnSite
13+ * Same as [[ openParenCallSite ]], except definition site.
14+ * @param tokens
15+ * The tokens to vertically align by. The "owner" is the
16+ * scala.meta.Tree.getClass.getName of the deepest tree node that "owns" the
17+ * token to align by.
2018 *
21- * Examples:
19+ * Examples:
2220 *
23- * align.tokens = ["="] // align = owned by any tree node (not recommended)
21+ * align.tokens = ["="] // align = owned by any tree node (not recommended)
2422 *
25- * align.tokens = [
26- * { code = "=", owner = "Param" } // align = when owned by parameter tree nodes
27- * ]
23+ * align.tokens = [ { code = "=", owner = "Param" } // align = when owned by
24+ * parameter tree nodes ]
2825 *
29- * Pro tip. if you use for example
26+ * Pro tip. if you use for example
3027 *
31- * preset = defaultWithAlign
28+ * preset = defaultWithAlign
3229 *
33- * and want to add one extra token (for example "|>") to align by, write
30+ * and want to add one extra token (for example "|>") to align by, write
3431 *
35- * align.tokens."+" = [ "|> ]
32+ * align.tokens."+" = [ "|> ]
3633 *
37- * NOTE. Adding more alignment tokens may potentially decrease the
38- * vertical alignment in formatted output. Customize at your own
39- * risk, I recommend you try and stick to the default settings.
40- * @param arrowEnumeratorGenerator If true, aligns by `<-` in for comprehensions.
34+ * NOTE. Adding more alignment tokens may potentially decrease the vertical
35+ * alignment in formatted output. Customize at your own risk, I recommend you
36+ * try and stick to the default settings.
37+ * @param arrowEnumeratorGenerator
38+ * If true, aligns by `<-` in for comprehensions.
4139 * @param openParenCtrlSite
42- * If true, aligns by ( in if/while/for. If false,
43- * indents by continuation indent at call site.
40+ * If true, aligns by ( in if/while/for. If false, indents by continuation
41+ * indent at call site.
4442 * @param tokenCategory
45- * Customize which token kinds can align together. By default, only tokens with
46- * the same `Token.productPrefix` align. To for example align = and <-,
47- * set the values to:
48- * Map("Equals" -> "Assign", "LeftArrow" -> "Assign")
43+ * Customize which token kinds can align together. By default, only tokens
44+ * with the same `Token.productPrefix` align. To for example align = and <-,
45+ * set the values to: Map("Equals" -> "Assign", "LeftArrow" -> "Assign")
4946 * Note. Requires mixedTokens to be true.
5047 * @param treeCategory
5148 * Customize which tree kinds can align together. By default, only trees with
5249 * the same `Tree.productPrefix` align. To for example align Defn.Val and
53- * Defn.Var, set the values to:
54- * Map("Defn.Var" -> "Assign", "Defn.Val" -> "Assign")
55- * Note. Requires mixedOwners to be true.
50+ * Defn.Var, set the values to: Map("Defn.Var" -> "Assign", "Defn.Val" ->
51+ * "Assign") Note. Requires mixedOwners to be true.
5652 * @param stripMargin
5753 * If set, indent lines with a strip-margin character in a multiline string
5854 * constant relative to the opening quotes (or the strip-margin character if
59- * present) on the first line; otherwise, indent relative to the beginning
60- * of the first line, as usual.
55+ * present) on the first line; otherwise, indent relative to the beginning of
56+ * the first line, as usual.
6157 */
6258case class Align (
6359 allowOverflow : Boolean = false ,
0 commit comments