Skip to content

CXX-2745 add v1 forward headers and component files (bsoncxx) #1336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 18 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/bsoncxx/include/bsoncxx/docs/top.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@

///
/// @namespace bsoncxx::types
/// Declares entities representing BSON value types.
/// Declares entities representing a BSON type.
///

///
/// @namespace bsoncxx::types::bson_value
/// Declares entities representing any BSON value type.
/// Declares entities representing a BSON type.
///
35 changes: 35 additions & 0 deletions src/bsoncxx/include/bsoncxx/docs/v1.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,11 @@
/// Provides headers declaring entities in @ref bsoncxx::v1.
///

///
/// @dir bsoncxx/v1/array
/// Provides headers declaring entities in @ref bsoncxx::v1::array.
///

///
/// @dir bsoncxx/v1/config
/// Provides headers related to bsoncxx library configuration.
Expand All @@ -40,17 +45,47 @@
/// @warning For internal use only!
///

///
/// @dir bsoncxx/v1/document
/// Provides headers declaring entities in @ref bsoncxx::v1::document.
///

///
/// @dir bsoncxx/v1/stdx
/// Provides headers declaring entities in @ref bsoncxx::v1::stdx.
///

///
/// @dir bsoncxx/v1/types
/// Provides headers declaring entities in @ref bsoncxx::v1::types.
///

///
/// @namespace bsoncxx::v1
/// Declares entities whose ABI stability is guaranteed for documented symbols.
///

///
/// @namespace bsoncxx::v1::array
/// @copydoc bsoncxx::array
///

///
/// @namespace bsoncxx::v1::document
/// @copydoc bsoncxx::document
///

///
/// @namespace bsoncxx::v1::error
/// Declares entities describing @ref bsoncxx::v1 errors.
///

///
/// @namespace bsoncxx::v1::stdx
/// @copydoc bsoncxx::stdx
///

///
/// @namespace bsoncxx::v1::types
/// @copydoc bsoncxx::types
///
2 changes: 1 addition & 1 deletion src/bsoncxx/include/bsoncxx/docs/v_noabi.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@

///
/// @namespace bsoncxx::v_noabi::types
/// @copydoc bsoncxx::types
/// Declares entities representing BSON value types.
///
/// @see
/// - @ref bsoncxx::v_noabi::types::bson_value
Expand Down
34 changes: 34 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/element-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// 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.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

class element;

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::array::element.
///
43 changes: 43 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/element.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// 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.

#pragma once

#include <bsoncxx/v1/array/element-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

///
/// An element within a BSON array.
///
/// @attention This feature is experimental! It is not ready for use!
///
class element {};

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::array::element.
///
34 changes: 34 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/value-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// 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.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

class value;

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::array::value.
///
43 changes: 43 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/value.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// 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.

#pragma once

#include <bsoncxx/v1/array/value-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

///
/// A BSON array.
///
/// @attention This feature is experimental! It is not ready for use!
///
class value {};

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::array::value.
///
34 changes: 34 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/view-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// 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.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

class view;

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::array::view.
///
43 changes: 43 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/array/view.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
// 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.

#pragma once

#include <bsoncxx/v1/array/view-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {
namespace array {

///
/// A non-owning, read-only BSON array.
///
/// @attention This feature is experimental! It is not ready for use!
///
class view {};

} // namespace array
} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::array::view.
///
32 changes: 32 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/decimal128-fwd.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// 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.

#pragma once

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {

class decimal128;

} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Declares @ref bsoncxx::v1::decimal128.
///
41 changes: 41 additions & 0 deletions src/bsoncxx/include/bsoncxx/v1/decimal128.hpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
// 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.

#pragma once

#include <bsoncxx/v1/decimal128-fwd.hpp>

//

#include <bsoncxx/v1/detail/prelude.hpp>

namespace bsoncxx {
namespace v1 {

///
/// A BSON Decimal128.
///
/// @attention This feature is experimental! It is not ready for use!
///
class decimal128 {};

} // namespace v1
} // namespace bsoncxx

#include <bsoncxx/v1/detail/postlude.hpp>

///
/// @file
/// Provides @ref bsoncxx::v1::decimal128.
///
Loading