From d5a6330bb6130d25be1c2c177d8a3f7b8a745f66 Mon Sep 17 00:00:00 2001 From: Mohammad Nejati Date: Fri, 12 Apr 2024 07:21:17 +0000 Subject: [PATCH] Remove Boostbook and Doxygen related files --- doc/.gitignore | 4 - doc/Jamfile | 145 ----------------------------------- doc/qbk/0.main.qbk | 62 --------------- doc/qbk/1.0.overview.qbk | 82 -------------------- doc/qbk/3.0.concepts.qbk | 20 ----- doc/qbk/index.xml | 15 ---- doc/qbk/quickref.xml | 84 -------------------- doc/xsl/custom-overrides.xsl | 32 -------- 8 files changed, 444 deletions(-) delete mode 100644 doc/Jamfile delete mode 100644 doc/qbk/0.main.qbk delete mode 100644 doc/qbk/1.0.overview.qbk delete mode 100644 doc/qbk/3.0.concepts.qbk delete mode 100644 doc/qbk/index.xml delete mode 100644 doc/qbk/quickref.xml delete mode 100644 doc/xsl/custom-overrides.xsl diff --git a/doc/.gitignore b/doc/.gitignore index 3183d7f..dd87e2d 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -1,6 +1,2 @@ -html -temp -out.txt -qbk/reference.qbk node_modules build diff --git a/doc/Jamfile b/doc/Jamfile deleted file mode 100644 index 269818f..0000000 --- a/doc/Jamfile +++ /dev/null @@ -1,145 +0,0 @@ -# -# Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) -# -# Distributed under the Boost Software License, Version 1.0. (See accompanying -# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -# -# Official repository: https://github.com/CPPAlliance/buffers -# - -project buffers/doc ; - -import boostbook ; -import os ; -import ../../../tools/docca/docca.jam ; - -path-constant broot : ../../../ ; - -path-constant out : . ; - -docca.reference reference.qbk - : - xsl/custom-overrides.xsl - [ glob-tree-ex ../include/boost/buffers : *.hpp *.ipp : detail impl ] - : - PROJECT_NAME=BUFFERS - PROJECT_BRIEF="Buffers Library" - ALIASES="esafe=\"@par Exception Safety\"" - FILE_PATTERNS= - EXAMPLE_PATTERNS= - DISTRIBUTE_GROUP_DOC=YES - MACRO_EXPANSION=YES - EXPAND_ONLY_PREDEF=YES - "PREDEFINED=\\ - BOOST_SYMBOL_VISIBLE \\ - BOOST_BUFFERS_DOCS \\ - BOOST_BUFFERS_DECL \\ - BOOST_BUFFERS_PUBLIC \\ - BOOST_BUFFERS_FORCEINLINE \\ - \"BOOST_BUFFERS_NODISCARD=[[nodiscard]]\" \\ - \"BOOST_STATIC_ASSERT(x)=\" \\ - \"BOOST_BUFFERS_INLINE_VARIABLE(v, t)=constexpr t v;\"" - ABBREVIATE_BRIEF= - INLINE_INHERITED_MEMB=YES - JAVADOC_AUTOBRIEF=YES - AUTOLINK_SUPPORT=NO - EXTRACT_ALL=YES - EXTRACT_PRIVATE=YES - EXTRACT_LOCAL_CLASSES=NO - SHOW_INCLUDE_FILES=NO - INLINE_INFO=NO - SORT_MEMBER_DOCS=NO - SORT_MEMBERS_CTORS_1ST=YES - SHOW_USED_FILES=NO - SHOW_FILES=NO - SHOW_NAMESPACES=NO - CLASS_DIAGRAMS=NO - - # ALLOW_UNICODE_NAMES=NO - # GROUP_NESTED_COMPOUNDS=NO - # HIDE_COMPOUND_REFERENCE=NO - # WARN_AS_ERROR=NO - ; - - -#------------------------------------------------------------------------------- -# -# Produce the Boost.Book XML from the QuickBook -# - -install images - : - [ glob images/*.png images/*.svg ] - : - html/buffers/images - ; - -explicit images ; - -install stylesheets - : - $(broot)/doc/src/boostbook.css - : - $(out)/html - ; - -explicit stylesheets ; - -install treeimages - : - [ glob $(broot)/doc/src/images/*.png ] - : - $(out)/html/images - ; - -explicit treeimages ; - -xml buffers_doc - : - qbk/0.main.qbk - : - reference.qbk - images - ; - -explicit buffers_doc ; - -#------------------------------------------------------------------------------- -# -# HTML documentation for $(BOOST_ROOT)/doc/html -# -#------------------------------------------------------------------------------- - -boostbook buffers - : - buffers_doc - : - boost.root=../../../.. - nav.layout=none - boost.graphics.root=images/ - html.stylesheet=boostbook.css - chapter.autolabel=1 - chunk.section.depth=8 # Depth to which sections should be chunked - chunk.first.sections=1 # Chunk the first top-level section? - toc.max.depth=8 # How many levels should be created for each TOC? - toc.section.depth=8 # How deep should recursive sections appear in the TOC? - #generate.toc="" - generate.toc="chapter toc,title section nop reference nop part toc" - ../../../tools/boostbook/dtd - : - stylesheets - treeimages - images - ; - -#------------------------------------------------------------------------------- -# -# These are used to inform the build system of the -# means to build the integrated and stand-alone docs. -# - -alias boostdoc ; -explicit boostdoc ; - -alias boostrelease : buffers ; -explicit boostrelease ; diff --git a/doc/qbk/0.main.qbk b/doc/qbk/0.main.qbk deleted file mode 100644 index e0c1070..0000000 --- a/doc/qbk/0.main.qbk +++ /dev/null @@ -1,62 +0,0 @@ -[/ - Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) - - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - - Official repository: https://github.com/CPPAlliance/buffers -] - -[library Boost.Buffers - [id buffers] - [quickbook 1.6] - [copyright 2023 Vinnie Falco] - [purpose Buffers utility library] - [license - Distributed under the Boost Software License, Version 1.0. - (See accompanying file LICENSE_1_0.txt or copy at - [@http://www.boost.org/LICENSE_1_0.txt]) - ] - [authors [Falco, Vinnie]] - [category template] - [category generic] -] - -[template mdash[] '''— '''] -[template indexterm1[term1] ''''''[term1]''''''] -[template indexterm2[term1 term2] ''''''[term1]''''''[term2]''''''] - -[template include_file[path][^<''''''[path]''''''>]] -[template issue[n] '''#'''[n]''''''] - -[/ Named Requirements ] - -[def __Allocator__ [@https://en.cppreference.com/w/cpp/named_req/Allocator ['Allocator]]] -[def __Copyable__ [@https://en.cppreference.com/w/cpp/concepts/copyable ['Copyable]]] -[def __CopyAssignable__ [@https://en.cppreference.com/w/cpp/named_req/CopyAssignable ['CopyAssignable]]] -[def __CopyConstructible__ [@https://en.cppreference.com/w/cpp/named_req/CopyConstructible ['CopyConstructible]]] -[def __DefaultConstructible__ [@https://en.cppreference.com/w/cpp/named_req/DefaultConstructible ['DefaultConstructible]]] -[def __InputIterator__ [@https://en.cppreference.com/w/cpp/named_req/InputIterator ['InputIterator]]] -[def __MoveAssignable__ [@https://en.cppreference.com/w/cpp/named_req/MoveAssignable ['MoveAssignable]]] -[def __MoveConstructible__ [@https://en.cppreference.com/w/cpp/named_req/MoveConstructible ['MoveConstructible]]] -[def __SemiRegular__ [@https://en.cppreference.com/w/cpp/concepts/semiregular ['SemiRegular]]] -[def __Swappable__ [@https://en.cppreference.com/w/cpp/named_req/Swappable ['Swappable]]] - -[def __ConstBufferSequence__ [link buffers.concepts.constbuffersequence ['ConstBufferSequence]]] -[def __MutableBufferSequence__ [link buffers.concepts.mutablebuffersequence ['MutableBufferSequence]]] -[def __Sink__ [link buffers.concepts.sink ['Sink]]] -[def __Source__ [link buffers.concepts.source ['Source]]] - -[/-----------------------------------------------------------------------------] - -[include 1.0.overview.qbk] -[include 3.0.concepts.qbk] - -[section:ref Reference] -[xinclude quickref.xml] -[block''''''] -[include reference.qbk] -[block''''''] -[endsect] - -[xinclude index.xml] diff --git a/doc/qbk/1.0.overview.qbk b/doc/qbk/1.0.overview.qbk deleted file mode 100644 index 881133e..0000000 --- a/doc/qbk/1.0.overview.qbk +++ /dev/null @@ -1,82 +0,0 @@ -[/ - Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) - - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - - Official repository: https://github.com/CPPAlliance/buffers -] - -[section Overview] -[block''''''] - -[/-----------------------------------------------------------------------------] - -Boost.Buffers is a portable, low-level C++ library which provides -containers and algorithms for describing contiguous buffers of -arbitrary bytes. - -Boost.Buffers offers these features: - -* Require only C++11 -* Works without exceptions -* Fast compilation, few templates -* Does not require Asio - -[/-----------------------------------------------------------------------------] - -[section Requirements] - -* Requires Boost and a compiler supporting at least C++11 -* Aliases for standard types use their Boost equivalents -* Link to a built static or dynamic Boost library, or use header-only (see below) -* Supports `-fno-exceptions`, detected automatically - -[heading Header-Only] - -To use the library as header-only; that is, to eliminate the requirement -to link a program to a static or dynamic Boost.URL library, simply place -the following line in [*exactly one] source file in your project. - -[c++] -``` -#include -``` - -[heading Embedded] - -Boost.Buffers works great on embedded devices. -It is designed to work without exceptions if desired. - -[endsect] - -[/-----------------------------------------------------------------------------] - -[section Supported Compilers] - -Boost.Buffers has been tested with the following compilers: - -* clang: 3.8, 4, 5, 6, 7, 8, 9, 10, 11, 12 -* gcc: 4.8, 4.9, 5, 6, 7, 8, 9, 10, 11 -* msvc: 14.1, 14.2, 14.3 - -[h3 Quality Assurance] - -The development infrastructure for the library includes -these per-commit analyses: - -* Coverage reports -* Compilation and tests on Drone.io - -[endsect] - -[/-----------------------------------------------------------------------------] - -[h1 Credits] - -This library is based on concepts and code developed -by Christopher Kohlhoff and published in Boost.Asio. - -[/-----------------------------------------------------------------------------] - -[endsect] diff --git a/doc/qbk/3.0.concepts.qbk b/doc/qbk/3.0.concepts.qbk deleted file mode 100644 index 2440be3..0000000 --- a/doc/qbk/3.0.concepts.qbk +++ /dev/null @@ -1,20 +0,0 @@ -[/ - Copyright (c) 2023 Vinnie Falco (vinnie.falco@gmail.com) - - Distributed under the Boost Software License, Version 1.0. (See accompanying - file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) - - Official repository: https://github.com/CPPAlliance/buffers -] - -[/-----------------------------------------------------------------------------] - -[section Concepts] - -[section ConstBufferSequence] -[endsect] - -[section MutableBufferSequence] -[endsect] - -[endsect] diff --git a/doc/qbk/index.xml b/doc/qbk/index.xml deleted file mode 100644 index 76e7825..0000000 --- a/doc/qbk/index.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - -
- Index - -
diff --git a/doc/qbk/quickref.xml b/doc/qbk/quickref.xml deleted file mode 100644 index b59bec6..0000000 --- a/doc/qbk/quickref.xml +++ /dev/null @@ -1,84 +0,0 @@ - - - - - - - - - - - Buffers - - - - - - Classes - - circular_buffer - const_buffer - const_buffer_pair - const_buffer_span - const_buffer_subspan - flat_buffer - mutable_buffer - mutable_buffer_pair - mutable_buffer_span - string_buffer - - - - - Functions - - begin - buffer_copy - buffer_size - end - front - make_buffer - prefix - range - sans_prefix - sans_suffix - suffix - - - - - Tags - - prefix_tag - size_tag - suffix_tag - - Type Traits - - is_const_buffer_sequence - is_mutable_buffer_sequence - is_dynamic_buffer - prefix_type - suffix_type - value_type - - - - - Concepts - - ConstBufferSequence - MutableBufferSequence - - - - - - diff --git a/doc/xsl/custom-overrides.xsl b/doc/xsl/custom-overrides.xsl deleted file mode 100644 index 736705e..0000000 --- a/doc/xsl/custom-overrides.xsl +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - - {$nl} - Convenience header [include_file boost/{$convenience-header}] - {$nl} - - - - buffers.hpp - - - - -