33 Commits

Author SHA1 Message Date
Martin Lindhe
8684c9960d fix some typos 2017-11-04 10:32:02 +01:00
Leo Mehr
3aafe12c91 undo changes to links and some minor changes to make the readme more easily readable 2017-06-30 12:42:06 -04:00
Leo Mehr
0d62f5cd35 Tutorial: fix typos in examples and broken links
In the move example, the code uses `contacts` when the diagrams use
`contact` (no 's')

The code in the example:
```    Value contacts(kArrayType);
    // adding elements to contacts array.
    // ...
    o.AddMember("contacts", contacts, d.GetAllocator());  // deep clone contacts (may be with lots of allocations)
    // destruct contacts.
```
2017-06-29 20:27:23 -04:00
Milo Yip
17254e090e Version 1.1.0
Change version numbers
Fixed some document linkage
Fix #648
2016-08-25 14:35:17 +08:00
Milo Yip
b34f18525e Fix tutorial bug 2016-06-15 09:41:56 +08:00
Mateusz Łoskot
74b41c1a43 Add missing allocator to uses of AddMember
AddMember requires allocator, this fix keeps all uses of AddMember consistent across the whole tutorial.
2015-06-24 17:22:48 +02:00
miloyip
c1b66cc082 Fix incorrect API in tutorial document. 2015-04-28 22:41:31 +08:00
Milo Yip
09118fa230 Merge pull request #192 from jollyroger/cmake
CMake support
2015-02-11 12:04:19 +08:00
Milo Yip
617c61a381 Documentation editing
Reorganized some features. Try to make the text clearer in features and
tutorial.
2015-02-08 19:08:26 +08:00
Andriy Senkovych
5cceb9e37a Fix broken references in documentation 2014-11-11 17:26:59 +02:00
Philipp A. Hartmann
e8445e0bbc GenericValue: improve operator[] disambiguation
In the original disambiguation fix for `GenericValue::operator[]` (#170),
the documentation has been missing, which led to quite badly rendered
Doxygen pages.

During a cleanup, I've realized that a much simpler disambiguation is
possible:

````cpp
  GenericValue& operator[](SizeType idx); // array
  template <typename T>
  GenericValue& operator[](T* name);      // object
````

This approach works, as non-template functions are preferred over
template functions.

In order to improve the error messages, the pointer type is restricted
to `(const) Ch`.

Update `tutorial.md` to drop the ambiguity warning.
2014-10-24 13:55:26 +02:00
Milo Yip
98f87905d9 Update tutorial.md
Correct `PushBack()` example
2014-09-26 11:32:25 +08:00
Philipp A. Hartmann
24b7976145 tutorial.md: lift restriction to object/array root values 2014-08-11 17:14:31 +02:00
Milo Yip
9892847021 Update documents about erase member/elements, also added some time complexity information. 2014-07-31 23:58:52 +08:00
Philipp A. Hartmann
12c5805c7e tutorial.md: update for new string API 2014-07-09 11:26:22 +02:00
Philipp A. Hartmann
58b741ac4b tutorial.md: document GenericValue::Move() 2014-07-09 11:25:55 +02:00
Milo Yip
62970ee230 Improves documentation style, TOC, fixes links.
Some links will become broken in GitHub.
2014-07-08 14:11:18 +08:00
miloyip
8d612570c8 Revise doxygen style
Imitate readthedocs
2014-07-07 19:15:10 +08:00
Milo Yip
bcd935be87 Merge remote-tracking branch 'origin/master'
Conflicts:
	doc/stream.md
	doc/tutorial.md
2014-07-06 22:48:21 +08:00
Milo Yip
698496e3f3 Minor document adjustments 2014-07-06 22:43:52 +08:00
Philipp A. Hartmann
ba05cc1377 tutorial.md: prepare Markdown for GitHub and Doxygen rendering 2014-07-06 15:35:43 +02:00
Milo Yip
3f3f847036 Add skeleton of documents 2014-07-04 23:57:33 +08:00
Milo Yip
3e4e68b099 Rearrange diagrams and fix typos in tutorial 2014-07-04 10:35:29 +08:00
Milo Yip
23318f2557 Complete tutorial draft 2014-07-03 23:46:30 +08:00
miloyip
f3fa423de0 Updates "Create/Modify Values" section 2014-07-03 19:20:33 +08:00
miloyip
f3ac1de589 Added creatie/modify value section to tutorial 2014-07-02 19:13:14 +08:00
Milo Yip
553a251b5a Update tutorial.md 2014-07-02 00:41:49 +08:00
Milo Yip
dfcf4f26dd Update tutorial.md 2014-07-02 00:35:42 +08:00
Milo Yip
a74c5da9da Update tutorial.md 2014-07-02 00:31:30 +08:00
Milo Yip
c1035cb970 Update tutorial.md 2014-07-02 00:29:33 +08:00
Milo Yip
cbc2c46bb8 Update tutorial.md
Fixes table
2014-07-02 00:27:27 +08:00
Milo Yip
bc2daea2f6 Add other query sections in tutorial 2014-07-02 00:20:36 +08:00
miloyip
84a4ff85c5 tutorial draft 2014-07-01 19:17:44 +08:00