Skip to content

Commit ebad9f6

Browse files
committed
README is updated
1 parent 39691c9 commit ebad9f6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Using the JSON support from the Qt Framework, this library allows user to define
55
1) Introduces the type awareness for the target JSON field. This allows the IDE to autocomplete the fields and their potential methods. Type awareness also prevents potential runtime errors that comes from mistyping or type safety related mistakes.
66
2) The object checks for the missing fields from the json data (it can be disabled)
77
3) Class interface reduces the verbosity while accessing the desired field
8+
Documentation can be seen with the following: ![Documentation](docs/html/index.html)
89

910

1011

@@ -14,10 +15,10 @@ Using the JSON support from the Qt Framework, this library allows user to define
1415

1516
Requirements for this library are as follows:
1617
1) QT Framework (Qt5 or later)
17-
2) C++11 or later
18+
2) C++17 or later
1819
\
1920
This library only uses the header files, so building the project isn't required. \
20-
Building the project executes the tests and runs the code example.
21+
Building the project can still be done for the tests and code examples.
2122

2223
## Usage/Examples
2324

@@ -35,15 +36,15 @@ Let's say, a file named "example.json" contains the following json data:
3536
"example_mixed_arr": [42, "is", "the", "answer", "to", "everything"]
3637
}
3738
```
38-
To parse this data, first we need to define our tagged JSON object class with the help of the "DEFINE_JSON_TAGGED_OBJECT" preprocessor macro. Each field of the defined class should match with the field names of the json data
39+
To parse this data, first we need to define our tagged JSON object class with the help of the "TJO_DEFINE_JSON_TAGGED_OBJECT" preprocessor macro. Each field of the defined class should match with the field names of the json data
3940

4041
```c++
4142
/*
4243
This is the definition for the inner object which will be used for defining the outer object.
4344
Alternatively, the inner class can be defined as TaggedQJsonObject at the outer class but this
4445
prevents inner class members to be accessed directly, which defeats the purpose of this library.
4546
*/
46-
DEFINE_JSON_TAGGED_OBJECT(InnerClass,
47+
TJO_DEFINE_JSON_TAGGED_OBJECT(InnerClass,
4748
(TaggedJSONString, example_sub_str))
4849

4950
/*
@@ -52,7 +53,7 @@ Other parameters are the type-field pairs that defines the members of the define
5253
It should be noted that TaggedJSONObject class variants should be used for the field types instead of
5354
the regular types like int, double etc.
5455
*/
55-
DEFINE_JSON_TAGGED_OBJECT(OuterClass,
56+
TJO_DEFINE_JSON_TAGGED_OBJECT(OuterClass,
5657
(TaggedJSONInt, example_int),
5758
(TaggedJSONString, example_str),
5859
(TaggedJSONDouble, example_double),

0 commit comments

Comments
 (0)