diff --git a/CHANGELOG.md b/CHANGELOG.md index ccec073e..49cc8ca6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,7 @@ Version 209: * test::stream maintains a handler work guard * Qualify buffer_copy, don't qualify buffer_size * Add dynamic_buffer_ref +* Refactor quickref.xml -------------------------------------------------------------------------------- diff --git a/doc/Jamfile b/doc/Jamfile index 1e12fa9e..f42881d8 100644 --- a/doc/Jamfile +++ b/doc/Jamfile @@ -159,7 +159,7 @@ explicit images ; xml beast_doc : - qbk/00_main.qbk + qbk/main.qbk : images qbk diff --git a/doc/qbk/00_main.qbk b/doc/qbk/main.qbk similarity index 98% rename from doc/qbk/00_main.qbk rename to doc/qbk/main.qbk index b08d8085..63e6aa99 100644 --- a/doc/qbk/00_main.qbk +++ b/doc/qbk/main.qbk @@ -133,6 +133,18 @@ [import ../../test/doc/core_1_refresher.cpp] [import ../../test/doc/core_3_layers.cpp] +[section:quickref Reference] +🞲 indicates item is new in this version. +[xinclude quickref.xml] +[endsect] +[block'''This Page Intentionally Left Blank 1/2'''] +[section:ref This Page Intentionally Left Blank 2/2] +[include reference.qbk] +[endsect] +[block''''''] + +[include release_notes.qbk] + [include 01_intro/0_intro.qbk] [include 02_examples/0_examples.qbk] [include 03_core/0_core.qbk] @@ -141,16 +153,5 @@ [include 06_websocket/0_websocket.qbk] [include 07_concepts/0_concepts.qbk] [include 08_design/0_design.qbk] -[include 09_releases.qbk] - -[section:quickref Reference] -[xinclude quickref.xml] -[endsect] - -[block'''This Page Intentionally Left Blank 1/2'''] -[section:ref This Page Intentionally Left Blank 2/2] -[include reference.qbk] -[endsect] -[block''''''] [xinclude index.xml] diff --git a/doc/qbk/quickref.xml b/doc/qbk/quickref.xml index 6b4a759c..1851a702 100644 --- a/doc/qbk/quickref.xml +++ b/doc/qbk/quickref.xml @@ -12,303 +12,332 @@ --> - - - - - - - - - HTTP - - - WebSocket - - - - - - - Classes - - basic_chunk_extensions - basic_dynamic_body - basic_fields - basic_file_body - basic_parser - basic_string_body - buffer_body - chunk_body - chunk_crlf - chunk_extensions - chunk_header - chunk_last - dynamic_body - empty_body - fields - file_body - header - message - parser - request - request_header - request_parser - request_serializer - response - response_header - response_parser - response_serializer - serializer - span_body - string_body - vector_body - - - - Functions - - async_read - async_read_header - async_read_some - async_write - async_write_header - async_write_some - int_to_status - make_chunk - make_chunk_last - obsolete_reason - operator<< - read - read_header - read_some - string_to_field - string_to_verb - swap - to_string - to_status_class - write - write_header - write_some - - rfc7230 - - ext_list - opt_token_list - param_list - token_list - - - - Constants - - error - field - status - status_class - verb - - Type Traits - - is_body - is_body_reader - is_body_writer - is_fields - is_mutable_body_writer - - Concepts - - Body - BodyReader - BodyWriter - Fields - FieldsWriter - - - - Classes - - close_reason - ping_data - stream - reason_string - - Functions - - async_teardown - is_upgrade - seed_prng - teardown - - Options - - permessage_deflate - - Constants - - close_code - condition - error - frame_type - role_type - - - - + + + + + Core + + + + Classes (1 of 2) + + async_op_base 🞲 + basic_timeout_stream 🞲 + file + file_mode + file_posix + file_stdio + file_win32 + flat_buffer + flat_static_buffer + flat_static_buffer_base + handler_ptr + iequal + iless + + + + Classes (2 of 2) + + saved_handler 🞲 + span + static_string + stable_async_op_base 🞲 + string_param + string_view + timeout_stream 🞲 + + Constants + + condition 🞲 + error 🞲 + file_mode + + + + Functions + + allocate_stable 🞲 + async_connect 🞲 + beast_close_socket 🞲 + bind_back_handler 🞲 + bind_front_handler 🞲 + bind_handler + close_socket 🞲 + generic_category + get_lowest_layer 🞲 + iequals + to_static_string + + + + Type Traits + + lowest_layer_type 🞲 + has_get_executor + is_async_read_stream + is_async_write_stream + is_async_stream + is_completion_handler + is_file + is_sync_read_stream + is_sync_stream + is_sync_write_stream + + + + Aliases + + errc + error_category + error_code + error_condition + system_category + system_error + + Concepts + + AsyncStream + File + Stream + SyncStream + + + + - - - - - - - - - Core - - - ZLib - - - - - - - Classes - - async_op_base + + + Buffers and Buffer-Oriented Operations + + + + Classes + basic_flat_buffer basic_multi_buffer - basic_timeout_stream buffered_read_stream buffers_adaptor buffers_cat_view buffers_prefix_view buffers_suffix - dynamic_buffer_ref_wrapper - file - file_mode - file_posix - file_stdio - file_win32 - flat_buffer - flat_static_buffer - flat_static_buffer_base - - - -   - - handler_ptr - iequal - iless + dynamic_buffer_ref_wrapper 🞲 multi_buffer - saved_handler - span static_buffer static_buffer_base - static_string - stable_async_op_base - string_param - string_view - timeout_stream - - Constants - - condition - error - file_mode - - - - Functions - - allocate_stable - async_connect - beast_close_socket - bind_back_handler - bind_front_handler - bind_handler - buffers_cat - buffers_front - buffers_prefix - buffers_range - buffers_range_ref - buffers_to_string - close_socket - dynamic_buffer_ref - generic_category - get_lowest_layer - iequals - make_printable - ostream - read_size - read_size_or_throw - to_static_string - - - - Type Traits - - buffers_type - buffers_iterator_type - lowest_layer_type - has_get_executor - is_async_read_stream - is_async_write_stream - is_async_stream - is_completion_handler - is_const_buffer_sequence - is_file - is_mutable_buffer_sequence - is_sync_read_stream - is_sync_stream - is_sync_write_stream - - - - Aliases - - errc - error_category - error_code - error_condition - system_category - system_error - - Concepts - - AsyncStream - BufferSequence - DynamicBuffer - File - Stream - SyncStream - - - - Classes - - deflate_stream - inflate_stream - z_params - - Functions - - deflate_upper_bound - - Constants - - error - Flush - Strategy - - - - + + + Functions + + buffers_cat + buffers_front + buffers_prefix + buffers_range 🞲 + buffers_range_ref 🞲 + buffers_to_string + dynamic_buffer_ref 🞲 + make_printable 🞲 + ostream + read_size + read_size_or_throw + + + Type Traits + + buffers_type 🞲 + buffers_iterator_type 🞲 + is_const_buffer_sequence 🞲 + is_mutable_buffer_sequence 🞲 + + + Concepts + + BufferSequence + DynamicBuffer + + + - + + + + + HTTP/1 + WebSocket + + + + Classes (1 of 2) + + basic_chunk_extensions + basic_dynamic_body + basic_fields + basic_file_body + basic_parser + basic_string_body + buffer_body + chunk_body + chunk_crlf + chunk_extensions + chunk_header + chunk_last + dynamic_body + empty_body + fields + file_body + header + message + parser + request + request_header + request_parser + request_serializer + response + response_header + response_parser + response_serializer + serializer + + + + Classes (2 of 2) + + span_body + string_body + vector_body + + Functions + + async_read + async_read_header + async_read_some + async_write + async_write_header + async_write_some + int_to_status + make_chunk + make_chunk_last + obsolete_reason + operator<< + read + read_header + read_some + string_to_field + string_to_verb + swap + to_string + to_status_class + write + write_header + write_some + + + + Constants + + error + field + status + status_class + verb + + Type Traits + + is_body + is_body_reader + is_body_writer + is_fields + is_mutable_body_writer + + Concepts + + Body + BodyReader + BodyWriter + Fields + FieldsWriter + + RFC7230 + + ext_list + opt_token_list + param_list + token_list + + + + Classes + + close_reason + ping_data + stream + reason_string + + Functions + + async_teardown + is_upgrade + seed_prng + teardown + + Options + + permessage_deflate + + Constants + + close_code + condition + error + frame_type + role_type + + + + + + + + + ZLib + + + + Classes + + deflate_stream + inflate_stream + z_params + + + Functions + + deflate_upper_bound + + + Constants + + error + Flush + Strategy + + + + + + @@ -346,13 +375,16 @@ +