CXX-3082 Add Comprehensive Examples (bsoncxx)

docs/api/bsoncxx/examples/bson_documents/access_array.md

@@ -0,0 +1,25 @@
+# Access an Array Element
+
+## By Iteration
+
+### Basic Example
+
+@snippet api/bsoncxx/examples/bson_documents/access_array/basic.cpp Example
+
+### Using Iterators
+
+@snippet api/bsoncxx/examples/bson_documents/access_array/iterators.cpp Example
+
+### Using Algorithms
+
+@snippet api/bsoncxx/examples/bson_documents/access_array/algorithms.cpp Example
+
+## By Key
+
+### Using find()
+
+@snippet api/bsoncxx/examples/bson_documents/access_array/find.cpp Example
+
+### Using the Subscript Operator
+
+@snippet api/bsoncxx/examples/bson_documents/access_array/subscript.cpp Example

docs/api/bsoncxx/examples/bson_documents/access_doc.md

@@ -0,0 +1,25 @@
+# Access a Document Element
+
+## By Iteration
+
+### Basic Example
+
+@snippet api/bsoncxx/examples/bson_documents/access_doc/basic.cpp Example
+
+### Using Iterators
+
+@snippet api/bsoncxx/examples/bson_documents/access_doc/iterators.cpp Example
+
+### Using Algorithms
+
+@snippet api/bsoncxx/examples/bson_documents/access_doc/algorithms.cpp Example
+
+## By Key
+
+### Using find()
+
+@snippet api/bsoncxx/examples/bson_documents/access_doc/find.cpp Example
+
+### Using the Subscript Operator
+
+@snippet api/bsoncxx/examples/bson_documents/access_doc/subscript.cpp Example

docs/api/bsoncxx/examples/bson_documents/create_array.md

@@ -0,0 +1,71 @@
+# Create an Array
+
+## From a JSON String
+
+### Basic Example
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/json_basic.cpp Example
+
+### With Extended JSON
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/json_extended.cpp Example
+
+### With a Sub-Document
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/json_sub_document.cpp Example
+
+### With a Sub-Array
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/json_sub_array.cpp Example
+
+### With a User-Defined Literal
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/json_udl.cpp Example
+
+## Using the Basic Builder
+
+### Basic Example
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_basic.cpp Example
+
+### With make_document
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_make_document.cpp Example
+
+### With Multiple Appends
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_append.cpp Example
+
+### To Create Multiple Documents
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_reset.cpp Example
+
+### With a Value Type
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_value_type.cpp Example
+
+### With a BSON Type
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_bson_type.cpp Example
+
+### With a BSON Value
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_bson_value.cpp Example
+
+### With a Sub-Document
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_sub_document.cpp Example
+
+### With a Sub-Array
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_sub_array.cpp Example
+
+## From Raw Bytes
+
+### As a View
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_raw_view.cpp Example
+
+### As a Value
+
+@snippet api/bsoncxx/examples/bson_documents/create_array/builder_raw_value.cpp Example

docs/api/bsoncxx/examples/bson_documents/create_doc.md

@@ -0,0 +1,71 @@
+# Create a Document
+
+## From a JSON String
+
+### Basic Example
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/json_basic.cpp Example
+
+### With Extended JSON
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/json_extended.cpp Example
+
+### With a Sub-Document
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/json_sub_document.cpp Example
+
+### With a Sub-Array
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/json_sub_array.cpp Example
+
+### With a User-Defined Literal
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/json_udl.cpp Example
+
+## Using the Basic Builder
+
+### Basic Example
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_basic.cpp Example
+
+### With make_document
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_make_document.cpp Example
+
+### With Multiple Appends
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_append.cpp Example
+
+### To Create Multiple Documents
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_reset.cpp Example
+
+### With a Value Type
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_value_type.cpp Example
+
+### With a BSON Type
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_bson_type.cpp Example
+
+### With a BSON Value
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_bson_value.cpp Example
+
+### With a Sub-Document
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_sub_document.cpp Example
+
+### With a Sub-Array
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_sub_array.cpp Example
+
+## From Raw Bytes
+
+### As a View
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_raw_view.cpp Example
+
+### As a Value
+
+@snippet api/bsoncxx/examples/bson_documents/create_doc/builder_raw_value.cpp Example

docs/api/bsoncxx/examples/bson_documents/elements.md

@@ -0,0 +1,31 @@
+# Query an Element
+
+## In a Document
+
+### For a Single Type
+
+@snippet api/bsoncxx/examples/bson_documents/elements/doc_single.cpp Example
+
+### For Multiple Types
+
+@snippet api/bsoncxx/examples/bson_documents/elements/doc_multi.cpp Example
+
+## In an Array
+
+### For Single Type
+
+@snippet api/bsoncxx/examples/bson_documents/elements/arr_single.cpp Example
+
+### For Multiple Types
+
+@snippet api/bsoncxx/examples/bson_documents/elements/arr_multi.cpp Example
+
+## Comparison
+
+### By Type
+
+@snippet api/bsoncxx/examples/bson_documents/elements/cmp_type.cpp Example
+
+### By BSON Value
+
+@snippet api/bsoncxx/examples/bson_documents/elements/cmp_bson_value.cpp Example

docs/api/bsoncxx/examples/bson_documents/json.md

@@ -0,0 +1,9 @@
+# Convert to a JSON String
+
+## From a Document
+
+@snippet api/bsoncxx/examples/bson_documents/json/document.cpp Example
+
+## From an Array
+
+@snippet api/bsoncxx/examples/bson_documents/json/array.cpp Example

docs/api/bsoncxx/examples/bson_documents/values.md

@@ -0,0 +1,39 @@
+# Obtain a BSON Value
+
+## From a BSON Type
+
+### As a View
+
+@snippet api/bsoncxx/examples/bson_documents/values/bson_type_view.cpp Example
+
+### As a Value
+
+@snippet api/bsoncxx/examples/bson_documents/values/bson_type_value.cpp Example
+
+## From a Document Element
+
+### As a View
+
+@snippet api/bsoncxx/examples/bson_documents/values/doc_view.cpp Example
+
+### As a Value
+
+@snippet api/bsoncxx/examples/bson_documents/values/doc_value.cpp Example
+
+## From an Array Element
+
+### As a View
+
+@snippet api/bsoncxx/examples/bson_documents/values/arr_view.cpp Example
+
+### As a Value
+
+@snippet api/bsoncxx/examples/bson_documents/values/arr_value.cpp Example
+
+## From a Value Type
+
+@snippet api/bsoncxx/examples/bson_documents/values/value_type.cpp Example
+
+## With make_value
+
+@snippet api/bsoncxx/examples/bson_documents/values/make_value.cpp Example

docs/api/bsoncxx/examples/bson_errors.md

@@ -0,0 +1,115 @@
+# Create a BSON Document
+
+## From an Invalid JSON String
+
+@snippet api/bsoncxx/examples/bson_errors/create_json.cpp Example
+
+## Using the Basic Document Builder
+
+### Basic Append Failure
+
+@snippet api/bsoncxx/examples/bson_errors/create_doc_append.cpp Example
+
+### Sub-Document Append Failure
+
+@snippet api/bsoncxx/examples/bson_errors/create_doc_append_sub_document.cpp Example
+
+### Sub-Array Append Failure
+
+@snippet api/bsoncxx/examples/bson_errors/create_doc_append_sub_array.cpp Example
+
+## Using the Basic Array Builder
+
+### Basic Append Failure
+
+@snippet api/bsoncxx/examples/bson_errors/create_arr_append.cpp Example
+
+### Sub-Document Append Failure
+
+@snippet api/bsoncxx/examples/bson_errors/create_arr_append_sub_document.cpp Example
+
+### Sub-Array Append Failure
+
+@snippet api/bsoncxx/examples/bson_errors/create_arr_append_sub_array.cpp Example
+
+# Access a Document Element
+
+## By Iteration
+
+### End Iterators
+
+@snippet api/bsoncxx/examples/bson_errors/access_doc_iter_end.cpp Example
+
+### Invalid BSON Documents
+
+@snippet api/bsoncxx/examples/bson_errors/access_doc_iter_invalid.cpp Example
+
+## By Key
+
+### Missing Element
+
+@snippet api/bsoncxx/examples/bson_errors/access_doc_key_missing.cpp Example
+
+# Access an Array Element
+
+## By Iteration
+
+### End Iterators
+
+@snippet api/bsoncxx/examples/bson_errors/access_arr_iter_end.cpp Example
+
+### Invalid BSON Arrays
+
+@snippet api/bsoncxx/examples/bson_errors/access_arr_iter_invalid.cpp Example
+
+## By Key
+
+### Missing Element
+
+@snippet api/bsoncxx/examples/bson_errors/access_arr_key_missing.cpp Example
+
+# Query an Element
+
+## In a Document
+
+### Invalid Element
+
+@snippet api/bsoncxx/examples/bson_errors/query_element_doc_invalid.cpp Example
+
+### Invalid Type
+
+@snippet api/bsoncxx/examples/bson_errors/query_element_doc_invalid_type.cpp Example
+
+## In an Array
+
+### Invalid Element
+
+@snippet api/bsoncxx/examples/bson_errors/query_element_arr_invalid.cpp Example
+
+### Invalid Type
+
+@snippet api/bsoncxx/examples/bson_errors/query_element_arr_invalid_type.cpp Example
+
+# Use a BSON Value
+
+## Query an Invalid Type
+
+@snippet api/bsoncxx/examples/bson_errors/query_bson_value_invalid_type.cpp Example
+
+## Create an Invalid Value
+
+@snippet api/bsoncxx/examples/bson_errors/create_bson_value_invalid_type.cpp Example
+
+## From an Invalid Element
+
+@snippet api/bsoncxx/examples/bson_errors/create_bson_value_invalid_element.cpp Example
+
+# Convert to a JSON String
+
+## From an Invalid BSON Document
+
+@snippet api/bsoncxx/examples/bson_errors/to_json_invalid_doc.cpp Example
+
+## From an Invalid BSON Array
+
+@snippet api/bsoncxx/examples/bson_errors/to_json_invalid_arr.cpp Example