annotate docs/specs/size.md @ 151:7a8ccd50bdf6

Misc: update .hgignore
author David Demelier <markand@malikania.fr>
date Mon, 04 Dec 2017 12:54:40 +0100
parents 835c8ee3f9e5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
98
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 # Size
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
2
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 A size describe an object which has width and height dimensions.
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
4
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 ## JSON Specification
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
6
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 ### Synopsis
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
8
136
835c8ee3f9e5 Docs: use ``` as fenced code blocks
David Demelier <markand@malikania.fr>
parents: 98
diff changeset
9 ```json
98
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 {
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 "width": 800,
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 "height: 600
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 }
136
835c8ee3f9e5 Docs: use ``` as fenced code blocks
David Demelier <markand@malikania.fr>
parents: 98
diff changeset
14 ```
98
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 ### Properties
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 - **width**: width as positive int,
f4d23ad4aa27 Common: refactoring class mlk::size
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 - **height**: height as positive int.