From 2a57d97f632865b3973f9ac07e49e74be3f4b95f Mon Sep 17 00:00:00 2001 From: "Philipp A. Hartmann" Date: Sat, 5 Jul 2014 17:11:15 +0200 Subject: [PATCH] features.md: prepare Markdown for GitHub and Doxygen rendering --- doc/features.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/features.md b/doc/features.md index f5d9355..3cc6309 100644 --- a/doc/features.md +++ b/doc/features.md @@ -39,10 +39,10 @@ ## API styles * SAX (Simple API for XML) style API - * Similar to [SAX](http://en.wikipedia.org/wiki/Simple_API_for_XML), RapidJSON provides a event sequential access parser API (`GenericReader`). It also provides a generator API (`GenericWriter`) which consumes the same set of events. + * Similar to [SAX](http://en.wikipedia.org/wiki/Simple_API_for_XML), RapidJSON provides a event sequential access parser API (`rapidjson::GenericReader`). It also provides a generator API (`rapidjson::Writer`) which consumes the same set of events. * DOM (Document Object Model) style API - * Similar to [DOM](http://en.wikipedia.org/wiki/Document_Object_Model) for HTML/XML, RapidJSON can parse JSON into a DOM representation (`GenericDocument`), for easy manipulation, and finally stringify back to JSON if needed. - * The DOM style API (`GenericDocument`) is actually implemented with SAX style API (`GenericReader`). SAX is faster but sometimes DOM is easier. Users can pick their choices according to scenarios. + * Similar to [DOM](http://en.wikipedia.org/wiki/Document_Object_Model) for HTML/XML, RapidJSON can parse JSON into a DOM representation (`rapidjson::GenericDocument`), for easy manipulation, and finally stringify back to JSON if needed. + * The DOM style API (`rapidjson::GenericDocument`) is actually implemented with SAX style API (`rapidjson::GenericReader`). SAX is faster but sometimes DOM is easier. Users can pick their choices according to scenarios. ## DOM (Document) @@ -59,13 +59,13 @@ ## SAX (Writer) -* Support PrettyWriter for adding newlines and indentations. +* Support `rapidjson::PrettyWriter` for adding newlines and indentations. * Support custom precision for floating point values. ## Stream -* Support `GenericStringBuffer` for storing the output JSON as string. -* Support `FileReadStream`/`FileWriteStream` for input/output `FILE` object. +* Support `rapidjson::GenericStringBuffer` for storing the output JSON as string. +* Support `rapidjson::FileReadStream`/`rapidjson::FileWriteStream` for input/output `FILE` object. * Support custom streams. ## Memory