// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#if !defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)
#error "This file is for documentation purposes only. It should not be included."
#endif // !defined(BSONCXX_PRIVATE_DOXYGEN_PREPROCESSOR)

///
/// @file
/// For documentation purposes only.
///
/// @note This header is not includable!
///

///
/// @page topic-bsoncxx The bsoncxx Library
/// @brief Topics relating to the bsoncxx library.
/// @li @subpage topic-bsoncxx-examples
/// @li @subpage topic-bsoncxx-about
///

///
/// @page topic-bsoncxx-examples How-To Guides
/// @brief Examples of how to use the bsoncxx library.
/// @li @subpage topic-bsoncxx-examples-bson-documents
/// @li @subpage topic-bsoncxx-examples-bson-errors
/// @li @subpage topic-bsoncxx-examples-decimal128
/// @li @subpage topic-bsoncxx-examples-oid
/// @li @subpage topic-bsoncxx-examples-validation
///

///
/// @page topic-bsoncxx-examples-bson-documents BSON Documents
/// @brief How to create and use BSON documents.
/// @tableofcontents
/// @include{doc} api/bsoncxx/examples/bson_documents/create_doc.md
/// @include{doc} api/bsoncxx/examples/bson_documents/create_array.md
/// @include{doc} api/bsoncxx/examples/bson_documents/access_doc.md
/// @include{doc} api/bsoncxx/examples/bson_documents/access_array.md
/// @include{doc} api/bsoncxx/examples/bson_documents/elements.md
/// @include{doc} api/bsoncxx/examples/bson_documents/values.md
/// @include{doc} api/bsoncxx/examples/bson_documents/json.md
///

///
/// @page topic-bsoncxx-examples-bson-errors BSON Error Handling
/// @brief How to handle BSON document failures, errors, and exceptions.
/// @tableofcontents
/// @include{doc} api/bsoncxx/examples/bson_errors.md
///

///
/// @page topic-bsoncxx-examples-decimal128 Decimal128
/// @brief How to use Decimal128 interfaces.
/// @tableofcontents
/// @see @parblock
/// @li [BSON Decimal128 Type Handling in Drivers (MongoDB
/// Specifications)](https://specifications.readthedocs.io/en/latest/bson-decimal128/decimal128/)
/// @li [Conversions (General Decimal Arithmetic
/// Specification)](https://speleotrove.com/decimal/daconvs.html)
/// @endparblock
/// @include{doc} api/bsoncxx/examples/decimal128.md
///

///
/// @page topic-bsoncxx-examples-oid ObjectID
/// @brief How to use ObjectID (OID) interfaces.
/// @tableofcontents
/// @include{doc} api/bsoncxx/examples/oid.md
///

///
/// @page topic-bsoncxx-examples-validation Validation
/// @brief How to use BSON document validation interfaces.
/// @tableofcontents
/// @include{doc} api/bsoncxx/examples/validation.md
///

///
/// @page topic-bsoncxx-about Explanation
/// @brief Design decisions, history, and other technical details about the bsoncxx library.
///
