Skip to content

Commit fd08124

Browse files
committed
doc: Add references to the spec for relevant options
1 parent 12545e8 commit fd08124

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

module/jsonurl-core/src/main/java/org/jsonurl/stream/JsonUrlEvent.java

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,46 +27,70 @@
2727
public enum JsonUrlEvent {
2828
/**
2929
* Start of a JSON→URL object.
30+
* @see <a href="https://github.com/jsonurl/specification#23-objects"
31+
* >JSON&#x2192;URL specification, section 2.3</a>
3032
*/
3133
START_OBJECT,
3234
/**
3335
* End of a JSON&#x2192;URL object.
36+
* @see <a href="https://github.com/jsonurl/specification#23-objects"
37+
* >JSON&#x2192;URL specification, section 2.3</a>
3438
*/
3539
END_OBJECT,
3640
/**
3741
* Start of a JSON&#x2192;URL array.
42+
* @see <a href="https://github.com/jsonurl/specification#24-arrays"
43+
* >JSON&#x2192;URL specification, section 2.4</a>
3844
*/
3945
START_ARRAY,
4046
/**
4147
* End of a JSON&#x2192;URL array.
48+
* @see <a href="https://github.com/jsonurl/specification#24-arrays"
49+
* >JSON&#x2192;URL specification, section 2.4</a>
4250
*/
4351
END_ARRAY,
4452
/**
4553
* A JSON&#x2192;URL object key name.
54+
* @see <a href="https://github.com/jsonurl/specification#23-objects"
55+
* >JSON&#x2192;URL specification, section 2.3</a>
4656
*/
4757
KEY_NAME,
4858
/**
4959
* A literal {@code false}.
60+
* @see <a href="https://github.com/jsonurl/specification#21-values"
61+
* >JSON&#x2192;URL specification, section 2.1</a>
5062
*/
5163
VALUE_FALSE,
5264
/**
5365
* A literal {@code true}.
66+
* @see <a href="https://github.com/jsonurl/specification#21-values"
67+
* >JSON&#x2192;URL specification, section 2.1</a>
5468
*/
5569
VALUE_TRUE,
5670
/**
5771
* A literal {@code null}.
72+
* @see <a href="https://github.com/jsonurl/specification#21-values"
73+
* >JSON&#x2192;URL specification, section 2.1</a>
5874
*/
5975
VALUE_NULL,
6076
/**
6177
* A number literal.
78+
* @see <a href="https://github.com/jsonurl/specification#26-numbers"
79+
* >JSON&#x2192;URL specification, section 2.6</a>
6280
*/
6381
VALUE_NUMBER,
6482
/**
6583
* A string literal.
84+
* @see <a href="https://github.com/jsonurl/specification#25-strings"
85+
* >JSON&#x2192;URL specification, section 2.5</a>
86+
* @see <a href="https://github.com/jsonurl/specification#296-address-bar-query-string-friendly"
87+
* >JSON&#x2192;URL specification, section 2.9.6</a>
6688
*/
6789
VALUE_STRING,
6890
/**
6991
* The empty composite.
92+
* @see <a href="https://github.com/jsonurl/specification#22-composites"
93+
* >JSON&#x2192;URL specification, section 2.2</a>
7094
*/
7195
VALUE_EMPTY_COMPOSITE,
7296
/**
@@ -76,6 +100,8 @@ public enum JsonUrlEvent {
76100
/**
77101
* A missing value (e.g. object key name with no
78102
* following separator and value).
103+
* @see <a href="https://github.com/jsonurl/specification#294-implied-object-missing-values"
104+
* >JSON&#x2192;URL specification, section 2.9.4</a>
79105
*/
80106
VALUE_MISSING,
81107
/**

0 commit comments

Comments
 (0)