Skip to content

Commit d0eb0e1

Browse files
committed
Converting expressions and semantics to tables
1 parent 63ea836 commit d0eb0e1

File tree

1 file changed

+116
-99
lines changed

1 file changed

+116
-99
lines changed

docs/modules/ROOT/pages/layout/sizing.adoc

+116-99
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,22 @@ Overrides the {limits} of an element.
2121
`limits` :: Instance of {view_limits}
2222
`subject` :: Instance of `Element`
2323

24-
=== Expression
24+
=== Expressions
2525

26-
[,c++]
26+
[cols="2,3", options="header"]
27+
|===
28+
| Expression | Semantics
29+
30+
a|
31+
[source,c++]
2732
----
2833
limit(limits, subject)
2934
----
30-
31-
=== Semantics
32-
33-
. The {limits} of `subject` will be set to the specified {limits}
34-
constrained by The natural _limits_ of the `subject`.
35+
a|
36+
. The {limits} of `subject` will be set to the specified {limits} constrained by the natural _limits_ of the `subject`.
3537
. The natural _limits_ of the element will not be violated.
36-
. Returns instance of `Proxy`.
38+
. Returns an instance of `Proxy`.
39+
|===
3740

3841
== fixed_size
3942

@@ -46,21 +49,24 @@ Fixes the size of an enclosed element (`subject`).
4649
`width`, `height` :: `float`
4750
`subject` :: Instance of `Element`
4851

49-
=== Expression
52+
=== Expressions
53+
54+
[cols="2,3", options="header"]
55+
|===
56+
| Expression | Semantics
5057

51-
[,c++]
58+
a|
59+
[source,c++]
5260
----
53-
fixed_size({width, height}, subject)
61+
fixed_size({width, height},
62+
subject
63+
)
5464
----
55-
56-
=== Semantics
57-
58-
. `subject` will be laid out with a fixed `width` and `height`, constrained
59-
by The natural _limits_ of the `subject`.
65+
a|
66+
. `subject` will be laid out with a fixed `width` and `height`, constrained by the natural _limits_ of the `subject`.
6067
. The natural _limits_ of the element will not be violated.
6168
. Returns instance of `Proxy`.
62-
63-
'''
69+
|===
6470

6571
== hsize
6672

@@ -73,22 +79,23 @@ Fixes the horizontal size of an enclosed element (`subject`).
7379
`width`:: `float`
7480
`subject`:: Instance of `Element`
7581

76-
=== Expression
82+
=== Expressions
7783

78-
[,c++]
84+
[cols="2,3", options="header"]
85+
|===
86+
| Expression | Semantics
87+
88+
a|
89+
[source,c++]
7990
----
8091
hsize(width, subject)
8192
----
82-
83-
=== Semantics
84-
85-
. `subject` will be laid out with a fixed `width`, constrained by the
86-
natural _horizontal limits_ of the `subject`.
93+
a|
94+
. `subject` will be laid out with a fixed `width`, constrained by the natural _horizontal limits_ of the `subject`.
8795
. The natural _horizontal limits_ of the element will not be violated.
8896
. The natural _vertical limits_ of `subject` will not be affected.
8997
. Returns instance of `Proxy`.
90-
91-
'''
98+
|===
9299

93100
== vsize
94101

@@ -101,22 +108,23 @@ Fixes the _vertical limits_ of an enclosed element (`subject`).
101108
`height`:: `float`
102109
`subject`:: Instance of `Element`
103110

104-
=== Expression
111+
=== Expressions
112+
113+
[cols="2,3", options="header"]
114+
|===
115+
| Expression | Semantics
105116

106-
[,c++]
117+
a|
118+
[source,c++]
107119
----
108120
vsize(height, subject)
109121
----
110-
111-
=== Semantics
112-
113-
. `subject` will be laid out with a fixed `height`, constrained by the
114-
natural _vertical limits_ of the `subject`.
122+
a|
123+
. `subject` will be laid out with a fixed `height`, constrained by the natural _vertical limits_ of the `subject`.
115124
. The natural _vertical limits_ of the element will not be violated.
116125
. The natural _horizontal limits_ of `subject` will not be affected.
117126
. Returns instance of `Proxy`.
118-
119-
'''
127+
|===
120128

121129
== min_size
122130

@@ -129,21 +137,24 @@ Overrides the _minimum limits_ of an enclosed element (`subject`).
129137
`width`, `height`:: `float`
130138
`subject`:: Instance of `Element`
131139

132-
=== Expression
140+
=== Expressions
141+
142+
[cols="2,3", options="header"]
143+
|===
144+
| Expression | Semantics
133145

134-
[,c++]
146+
a|
147+
[source,c++]
135148
----
136-
min_size({width, height}, subject)
149+
min_size({width, height},
150+
subject
151+
)
137152
----
138-
139-
=== Semantics
140-
141-
. The _minimum limits_ of `subject` will be set to the specified `width` and
142-
`height`, constrained by the natural _minimum limits_ of the `subject`.
143-
. the natural _minimum limits_ of the element will not be violated.
153+
a|
154+
. The _minimum limits_ of `subject` will be set to the specified `width` and `height`, constrained by the natural _minimum limits_ of the `subject`.
155+
. The natural _minimum limits_ of the element will not be violated.
144156
. Returns instance of `Proxy`.
145-
146-
'''
157+
|===
147158

148159
== hmin_size
149160

@@ -156,23 +167,22 @@ Overrides the _minimum horizontal limit_ of an enclosed element (`subject`).
156167
`width`:: `float`
157168
`subject`:: Instance of `Element`
158169

159-
=== Expression
170+
=== Expressions
160171

161-
[,c++]
172+
[cols="2,3", options="header"]
173+
|===
174+
| Expression | Semantics
175+
176+
a|
177+
[source,c++]
162178
----
163179
hmin_size(width, subject)
164180
----
165-
166-
=== Semantics
167-
168-
. The _minimum horizontal limit_ of `subject` will be set to the specified
169-
`width` constrained by the natural _horizontal minimum limits_ of the
170-
`subject`.
171-
. The natural _horizontal minimum limits_ of the element will not be
172-
violated.
181+
a|
182+
. The _minimum horizontal limit_ of `subject` will be set to the specified `width` constrained by the natural _horizontal minimum limits_ of the `subject`.
183+
. The natural _horizontal minimum limits_ of the element will not be violated.
173184
. Returns instance of `Proxy`.
174-
175-
'''
185+
|===
176186

177187
== vmin_size
178188

@@ -185,21 +195,22 @@ Overrides the _minimum vertical limit_ of an enclosed element (`subject`).
185195
`height`:: `float`
186196
`subject`:: Instance of `Element`
187197

188-
=== Expression
198+
=== Expressions
199+
200+
[cols="2,3", options="header"]
201+
|===
202+
| Expression | Semantics
189203

190-
[,c++]
204+
a|
205+
[source,c++]
191206
----
192207
vmin_size(height, subject)
193208
----
194-
195-
=== Semantics
196-
197-
. The _minimum vertical limit_ of `subject` will be set to the specified `height`
198-
constrained by the natural vertical _minimum limits_ of the `subject`.
209+
a|
210+
. The _minimum vertical limit_ of `subject` will be set to the specified `height` constrained by the natural vertical _minimum limits_ of the `subject`.
199211
. The natural _vertical minimum limits_ of the element will not be violated.
200212
. Returns instance of `Proxy`.
201-
202-
'''
213+
|===
203214

204215
== max_size
205216

@@ -212,21 +223,24 @@ Overrides the _maximum limits_ of an enclosed element (`subject`).
212223
`width`, `height`:: `float`
213224
`subject`:: Instance of `Element`
214225

215-
=== Expression
226+
=== Expressions
216227

217-
[,c++]
228+
[cols="2,3", options="header"]
229+
|===
230+
| Expression | Semantics
231+
232+
a|
233+
[source,c++]
218234
----
219-
max_size({width, height}, subject)
235+
max_size({width, height},
236+
subject
237+
)
220238
----
221-
222-
=== Semantics
223-
224-
. The _maximum limits_ of `subject` will be set to the specified `width` and
225-
`height`, constrained by the natural _maximum limits_ of the `subject`.
239+
a|
240+
. The _maximum limits_ of `subject` will be set to the specified `width` and `height`, constrained by the natural _maximum limits_ of the `subject`.
226241
. The natural _maximum limits_ of the element will not be violated.
227242
. Returns instance of `Proxy`.
228-
229-
'''
243+
|===
230244

231245
== hmax_size
232246

@@ -239,23 +253,24 @@ Overrides the _maximum horizontal limit_ of an enclosed element (`subject`).
239253
`width`:: `float`
240254
`subject`:: Instance of `Element`
241255

242-
=== Expression
256+
=== Expressions
257+
258+
[cols="2,3", options="header"]
259+
|===
260+
| Expression | Semantics
243261

244-
[,c++]
262+
a|
263+
[source,c++]
245264
----
246-
hmax_size(width, subject)
265+
max_size({width, height},
266+
subject
267+
)
247268
----
248-
249-
=== Semantics
250-
251-
. The _maximum horizontal limit_ of `subject` will be set to the specified
252-
`width` constrained by the natural _maximum horizontal limit_ of the
253-
`subject`.
254-
. The natural _maximum horizontal limit_ of the element will not be
255-
violated.
269+
a|
270+
. The _maximum limits_ of `subject` will be set to the specified `width` and `height`, constrained by the natural _maximum limits_ of the `subject`.
271+
. The natural _maximum limits_ of the element will not be violated.
256272
. Returns instance of `Proxy`.
257-
258-
'''
273+
|===
259274

260275
== vmax_size
261276

@@ -268,20 +283,22 @@ Overrides the _maximum vertical limit_ of an enclosed element (`subject`).
268283
`height`:: `float`
269284
`subject`:: Instance of `Element`
270285

271-
=== Expression
286+
=== Expressions
287+
288+
[cols="2,3", options="header"]
289+
|===
290+
| Expression | Semantics
272291

273-
[,c++]
292+
a|
293+
[source,c++]
274294
----
275295
vmax_size(height, subject)
276296
----
277-
278-
=== Semantics
279-
280-
. The _maximum vertical limit_ of `subject` will be set to the specified
281-
`height` constrained by the natural _maximum vertical limit_ of the
282-
`subject`
297+
a|
298+
. The _maximum vertical limit_ of `subject` will be set to the specified `height` constrained by the natural _maximum vertical limit_ of the `subject`.
283299
. The natural _maximum vertical limit_ of the element will not be violated.
284300
. Returns instance of `Proxy`.
301+
|===
285302

286303
---
287304

0 commit comments

Comments
 (0)