Capture exceptions by const& in docs. (#4099)

iwanders · web-flow · commit aa87ab8b4068 · 2023-09-23T17:19:50.000+02:00
diff --git a/docs/examples/at__json_pointer.cpp b/docs/examples/at__json_pointer.cpp
@@ -41,7 +41,7 @@ int main()
         // try to use an array index with leading '0'
         json::reference ref = j.at("/array/01"_json_pointer);
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -52,7 +52,7 @@ int main()
         // try to use an array index that is not a number
         json::reference ref = j.at("/array/one"_json_pointer);
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -63,7 +63,7 @@ int main()
         // try to use an invalid array index
         json::reference ref = j.at("/array/4"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -74,7 +74,7 @@ int main()
         // try to use the array index '-'
         json::reference ref = j.at("/array/-"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -85,7 +85,7 @@ int main()
         // try to use a JSON pointer to a nonexistent object key
         json::const_reference ref = j.at("/foo"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -96,7 +96,7 @@ int main()
         // try to use a JSON pointer that cannot be resolved
         json::reference ref = j.at("/number/foo"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/at__json_pointer_const.cpp b/docs/examples/at__json_pointer_const.cpp
@@ -29,7 +29,7 @@ int main()
         // try to use an array index that is not a number
         json::const_reference ref = j.at("/array/one"_json_pointer);
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -40,7 +40,7 @@ int main()
         // try to use an invalid array index
         json::const_reference ref = j.at("/array/4"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -51,7 +51,7 @@ int main()
         // try to use the array index '-'
         json::const_reference ref = j.at("/array/-"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -62,7 +62,7 @@ int main()
         // try to use a JSON pointer to a nonexistent object key
         json::const_reference ref = j.at("/foo"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -73,7 +73,7 @@ int main()
         // try to use a JSON pointer that cannot be resolved
         json::const_reference ref = j.at("/number/foo"_json_pointer);
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/at__keytype.c++17.cpp b/docs/examples/at__keytype.c++17.cpp
@@ -31,7 +31,7 @@ int main()
         json str = "I am a string";
         str.at("the good"sv) = "Another string";
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -42,7 +42,7 @@ int main()
         // try to write at a nonexisting key using string_view
         object.at("the fast"sv) = "il rapido";
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/at__keytype_const.c++17.cpp b/docs/examples/at__keytype_const.c++17.cpp
@@ -25,7 +25,7 @@ int main()
         const json str = "I am a string";
         std::cout << str.at("the good"sv) << '\n';
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -36,7 +36,7 @@ int main()
         // try to read from a nonexisting key using string_view
         std::cout << object.at("the fast"sv) << '\n';
     }
-    catch (json::out_of_range)
+    catch (const json::out_of_range)
     {
         std::cout << "out of range" << '\n';
     }
diff --git a/docs/examples/at__object_t_key_type.cpp b/docs/examples/at__object_t_key_type.cpp
@@ -29,7 +29,7 @@ int main()
         json str = "I am a string";
         str.at("the good") = "Another string";
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -40,7 +40,7 @@ int main()
         // try to write at a nonexisting key
         object.at("the fast") = "il rapido";
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/at__object_t_key_type_const.cpp b/docs/examples/at__object_t_key_type_const.cpp
@@ -23,7 +23,7 @@ int main()
         const json str = "I am a string";
         std::cout << str.at("the good") << '\n';
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -34,7 +34,7 @@ int main()
         // try to read from a nonexisting key
         std::cout << object.at("the fast") << '\n';
     }
-    catch (json::out_of_range)
+    catch (const json::out_of_range)
     {
         std::cout << "out of range" << '\n';
     }
diff --git a/docs/examples/at__size_type.cpp b/docs/examples/at__size_type.cpp
@@ -24,7 +24,7 @@ int main()
         json str = "I am a string";
         str.at(0) = "Another string";
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -35,7 +35,7 @@ int main()
         // try to write beyond the array limit
         array.at(5) = "sixth";
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/at__size_type_const.cpp b/docs/examples/at__size_type_const.cpp
@@ -18,7 +18,7 @@ int main()
         const json str = "I am a string";
         std::cout << str.at(0) << '\n';
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -29,7 +29,7 @@ int main()
         // try to read beyond the array limit
         std::cout << array.at(5) << '\n';
     }
-    catch (json::out_of_range& e)
+    catch (const json::out_of_range& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/back.cpp b/docs/examples/back.cpp
@@ -31,7 +31,7 @@ int main()
         json j_null;
         j_null.back();
     }
-    catch (json::invalid_iterator& e)
+    catch (const json::invalid_iterator& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/basic_json__InputIt_InputIt.cpp b/docs/examples/basic_json__InputIt_InputIt.cpp
@@ -25,7 +25,7 @@ int main()
     {
         json j_invalid(j_number.begin() + 1, j_number.end());
     }
-    catch (json::invalid_iterator& e)
+    catch (const json::invalid_iterator& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/cbor_tag_handler_t.cpp b/docs/examples/cbor_tag_handler_t.cpp
@@ -13,7 +13,7 @@ int main()
     {
         auto b_throw_on_tag = json::from_cbor(vec, true, true, json::cbor_tag_handler_t::error);
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << std::endl;
     }
diff --git a/docs/examples/contains__json_pointer.cpp b/docs/examples/contains__json_pointer.cpp
@@ -26,7 +26,7 @@ int main()
         // try to use an array index with leading '0'
         j.contains("/array/01"_json_pointer);
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -36,7 +36,7 @@ int main()
         // try to use an array index that is not a number
         j.contains("/array/one"_json_pointer);
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/diagnostics_extended.cpp b/docs/examples/diagnostics_extended.cpp
@@ -15,7 +15,7 @@ int main()
     {
         int housenumber = j["address"]["housenumber"];
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/diagnostics_standard.cpp b/docs/examples/diagnostics_standard.cpp
@@ -13,7 +13,7 @@ int main()
     {
         int housenumber = j["address"]["housenumber"];
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/dump.cpp b/docs/examples/dump.cpp
@@ -35,7 +35,7 @@ int main()
     {
         std::cout << j_invalid.dump() << std::endl;
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << std::endl;
     }
diff --git a/docs/examples/error_handler_t.cpp b/docs/examples/error_handler_t.cpp
@@ -11,7 +11,7 @@ int main()
     {
         std::cout << j_invalid.dump() << std::endl;
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << std::endl;
     }
diff --git a/docs/examples/exception.cpp b/docs/examples/exception.cpp
@@ -11,7 +11,7 @@ int main()
         json j = {{"foo", "bar"}};
         json k = j.at("non-existing");
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         // output exception information
         std::cout << "message: " << e.what() << '\n'
diff --git a/docs/examples/get_ref.cpp b/docs/examples/get_ref.cpp
@@ -20,7 +20,7 @@ int main()
     {
         auto r3 = value.get_ref<json::number_float_t&>();
     }
-    catch (json::type_error& ex)
+    catch (const json::type_error& ex)
     {
         std::cout << ex.what() << '\n';
     }
diff --git a/docs/examples/invalid_iterator.cpp b/docs/examples/invalid_iterator.cpp
@@ -12,7 +12,7 @@ int main()
         json::iterator it = j.begin();
         auto k = it.key();
     }
-    catch (json::invalid_iterator& e)
+    catch (const json::invalid_iterator& e)
     {
         // output exception information
         std::cout << "message: " << e.what() << '\n'
diff --git a/docs/examples/json_pointer.cpp b/docs/examples/json_pointer.cpp
@@ -20,7 +20,7 @@ int main()
     {
         json::json_pointer p9("foo");
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -30,7 +30,7 @@ int main()
     {
         json::json_pointer p10("/foo/~");
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
@@ -40,7 +40,7 @@ int main()
     {
         json::json_pointer p11("/foo/~3");
     }
-    catch (json::parse_error& e)
+    catch (const json::parse_error& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/nlohmann_define_type_intrusive_explicit.cpp b/docs/examples/nlohmann_define_type_intrusive_explicit.cpp
@@ -53,7 +53,7 @@ int main()
     {
         auto p3 = j3.template get<ns::person>();
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         std::cout << "deserialization failed: " << e.what() << std::endl;
     }
diff --git a/docs/examples/nlohmann_define_type_intrusive_macro.cpp b/docs/examples/nlohmann_define_type_intrusive_macro.cpp
@@ -41,7 +41,7 @@ int main()
     {
         auto p3 = j3.template get<ns::person>();
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         std::cout << "deserialization failed: " << e.what() << std::endl;
     }
diff --git a/docs/examples/nlohmann_define_type_non_intrusive_explicit.cpp b/docs/examples/nlohmann_define_type_non_intrusive_explicit.cpp
@@ -46,7 +46,7 @@ int main()
     {
         auto p3 = j3.template get<ns::person>();
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         std::cout << "deserialization failed: " << e.what() << std::endl;
     }
diff --git a/docs/examples/nlohmann_define_type_non_intrusive_macro.cpp b/docs/examples/nlohmann_define_type_non_intrusive_macro.cpp
@@ -34,7 +34,7 @@ int main()
     {
         auto p3 = j3.template get<ns::person>();
     }
-    catch (json::exception& e)
+    catch (const json::exception& e)
     {
         std::cout << "deserialization failed: " << e.what() << std::endl;
     }
diff --git a/docs/examples/object.cpp b/docs/examples/object.cpp
@@ -21,7 +21,7 @@ int main()
         // can only create an object from a list of pairs
         json j_invalid_object = json::object({{ "one", 1, 2 }});
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/operator__ValueType.cpp b/docs/examples/operator__ValueType.cpp
@@ -53,7 +53,7 @@ int main()
     {
         bool v1 = json_types["string"];
     }
-    catch (json::type_error& e)
+    catch (const json::type_error& e)
     {
         std::cout << e.what() << '\n';
     }
diff --git a/docs/examples/other_error.cpp b/docs/examples/other_error.cpp
diff --git a/docs/examples/out_of_range.cpp b/docs/examples/out_of_range.cpp
diff --git a/docs/examples/parse__allow_exceptions.cpp b/docs/examples/parse__allow_exceptions.cpp
diff --git a/docs/examples/parse_error.cpp b/docs/examples/parse_error.cpp
diff --git a/docs/examples/type_error.cpp b/docs/examples/type_error.cpp

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ int main()`
`41`	`41`	`// try to use an array index with leading '0'`
`42`	`42`	`json::reference ref = j.at("/array/01"_json_pointer);`
`43`	`43`	`}`
`44`		`- catch (json::parse_error& e)`
	`44`	`+ catch (const json::parse_error& e)`
`45`	`45`	`{`
`46`	`46`	`std::cout << e.what() << '\n';`
`47`	`47`	`}`
`@@ -52,7 +52,7 @@ int main()`
`52`	`52`	`// try to use an array index that is not a number`
`53`	`53`	`json::reference ref = j.at("/array/one"_json_pointer);`
`54`	`54`	`}`
`55`		`- catch (json::parse_error& e)`
	`55`	`+ catch (const json::parse_error& e)`
`56`	`56`	`{`
`57`	`57`	`std::cout << e.what() << '\n';`
`58`	`58`	`}`
`@@ -63,7 +63,7 @@ int main()`
`63`	`63`	`// try to use an invalid array index`
`64`	`64`	`json::reference ref = j.at("/array/4"_json_pointer);`
`65`	`65`	`}`
`66`		`- catch (json::out_of_range& e)`
	`66`	`+ catch (const json::out_of_range& e)`
`67`	`67`	`{`
`68`	`68`	`std::cout << e.what() << '\n';`
`69`	`69`	`}`
`@@ -74,7 +74,7 @@ int main()`
`74`	`74`	`// try to use the array index '-'`
`75`	`75`	`json::reference ref = j.at("/array/-"_json_pointer);`
`76`	`76`	`}`
`77`		`- catch (json::out_of_range& e)`
	`77`	`+ catch (const json::out_of_range& e)`
`78`	`78`	`{`
`79`	`79`	`std::cout << e.what() << '\n';`
`80`	`80`	`}`
`@@ -85,7 +85,7 @@ int main()`
`85`	`85`	`// try to use a JSON pointer to a nonexistent object key`
`86`	`86`	`json::const_reference ref = j.at("/foo"_json_pointer);`
`87`	`87`	`}`
`88`		`- catch (json::out_of_range& e)`
	`88`	`+ catch (const json::out_of_range& e)`
`89`	`89`	`{`
`90`	`90`	`std::cout << e.what() << '\n';`
`91`	`91`	`}`
`@@ -96,7 +96,7 @@ int main()`
`96`	`96`	`// try to use a JSON pointer that cannot be resolved`
`97`	`97`	`json::reference ref = j.at("/number/foo"_json_pointer);`
`98`	`98`	`}`
`99`		`- catch (json::out_of_range& e)`
	`99`	`+ catch (const json::out_of_range& e)`
`100`	`100`	`{`
`101`	`101`	`std::cout << e.what() << '\n';`
`102`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ int main()`
`29`	`29`	`// try to use an array index that is not a number`
`30`	`30`	`json::const_reference ref = j.at("/array/one"_json_pointer);`
`31`	`31`	`}`
`32`		`- catch (json::parse_error& e)`
	`32`	`+ catch (const json::parse_error& e)`
`33`	`33`	`{`
`34`	`34`	`std::cout << e.what() << '\n';`
`35`	`35`	`}`
`@@ -40,7 +40,7 @@ int main()`
`40`	`40`	`// try to use an invalid array index`
`41`	`41`	`json::const_reference ref = j.at("/array/4"_json_pointer);`
`42`	`42`	`}`
`43`		`- catch (json::out_of_range& e)`
	`43`	`+ catch (const json::out_of_range& e)`
`44`	`44`	`{`
`45`	`45`	`std::cout << e.what() << '\n';`
`46`	`46`	`}`
`@@ -51,7 +51,7 @@ int main()`
`51`	`51`	`// try to use the array index '-'`
`52`	`52`	`json::const_reference ref = j.at("/array/-"_json_pointer);`
`53`	`53`	`}`
`54`		`- catch (json::out_of_range& e)`
	`54`	`+ catch (const json::out_of_range& e)`
`55`	`55`	`{`
`56`	`56`	`std::cout << e.what() << '\n';`
`57`	`57`	`}`
`@@ -62,7 +62,7 @@ int main()`
`62`	`62`	`// try to use a JSON pointer to a nonexistent object key`
`63`	`63`	`json::const_reference ref = j.at("/foo"_json_pointer);`
`64`	`64`	`}`
`65`		`- catch (json::out_of_range& e)`
	`65`	`+ catch (const json::out_of_range& e)`
`66`	`66`	`{`
`67`	`67`	`std::cout << e.what() << '\n';`
`68`	`68`	`}`
`@@ -73,7 +73,7 @@ int main()`
`73`	`73`	`// try to use a JSON pointer that cannot be resolved`
`74`	`74`	`json::const_reference ref = j.at("/number/foo"_json_pointer);`
`75`	`75`	`}`
`76`		`- catch (json::out_of_range& e)`
	`76`	`+ catch (const json::out_of_range& e)`
`77`	`77`	`{`
`78`	`78`	`std::cout << e.what() << '\n';`
`79`	`79`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ int main()`
`31`	`31`	`json str = "I am a string";`
`32`	`32`	`str.at("the good"sv) = "Another string";`
`33`	`33`	`}`
`34`		`- catch (json::type_error& e)`
	`34`	`+ catch (const json::type_error& e)`
`35`	`35`	`{`
`36`	`36`	`std::cout << e.what() << '\n';`
`37`	`37`	`}`
`@@ -42,7 +42,7 @@ int main()`
`42`	`42`	`// try to write at a nonexisting key using string_view`
`43`	`43`	`object.at("the fast"sv) = "il rapido";`
`44`	`44`	`}`
`45`		`- catch (json::out_of_range& e)`
	`45`	`+ catch (const json::out_of_range& e)`
`46`	`46`	`{`
`47`	`47`	`std::cout << e.what() << '\n';`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ int main()`
`25`	`25`	`const json str = "I am a string";`
`26`	`26`	`std::cout << str.at("the good"sv) << '\n';`
`27`	`27`	`}`
`28`		`- catch (json::type_error& e)`
	`28`	`+ catch (const json::type_error& e)`
`29`	`29`	`{`
`30`	`30`	`std::cout << e.what() << '\n';`
`31`	`31`	`}`
`@@ -36,7 +36,7 @@ int main()`
`36`	`36`	`// try to read from a nonexisting key using string_view`
`37`	`37`	`std::cout << object.at("the fast"sv) << '\n';`
`38`	`38`	`}`
`39`		`- catch (json::out_of_range)`
	`39`	`+ catch (const json::out_of_range)`
`40`	`40`	`{`
`41`	`41`	`std::cout << "out of range" << '\n';`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ int main()`
`23`	`23`	`const json str = "I am a string";`
`24`	`24`	`std::cout << str.at("the good") << '\n';`
`25`	`25`	`}`
`26`		`- catch (json::type_error& e)`
	`26`	`+ catch (const json::type_error& e)`
`27`	`27`	`{`
`28`	`28`	`std::cout << e.what() << '\n';`
`29`	`29`	`}`
`@@ -34,7 +34,7 @@ int main()`
`34`	`34`	`// try to read from a nonexisting key`
`35`	`35`	`std::cout << object.at("the fast") << '\n';`
`36`	`36`	`}`
`37`		`- catch (json::out_of_range)`
	`37`	`+ catch (const json::out_of_range)`
`38`	`38`	`{`
`39`	`39`	`std::cout << "out of range" << '\n';`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ int main()`
`24`	`24`	`json str = "I am a string";`
`25`	`25`	`str.at(0) = "Another string";`
`26`	`26`	`}`
`27`		`- catch (json::type_error& e)`
	`27`	`+ catch (const json::type_error& e)`
`28`	`28`	`{`
`29`	`29`	`std::cout << e.what() << '\n';`
`30`	`30`	`}`
`@@ -35,7 +35,7 @@ int main()`
`35`	`35`	`// try to write beyond the array limit`
`36`	`36`	`array.at(5) = "sixth";`
`37`	`37`	`}`
`38`		`- catch (json::out_of_range& e)`
	`38`	`+ catch (const json::out_of_range& e)`
`39`	`39`	`{`
`40`	`40`	`std::cout << e.what() << '\n';`
`41`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ int main()`
`18`	`18`	`const json str = "I am a string";`
`19`	`19`	`std::cout << str.at(0) << '\n';`
`20`	`20`	`}`
`21`		`- catch (json::type_error& e)`
	`21`	`+ catch (const json::type_error& e)`
`22`	`22`	`{`
`23`	`23`	`std::cout << e.what() << '\n';`
`24`	`24`	`}`
`@@ -29,7 +29,7 @@ int main()`
`29`	`29`	`// try to read beyond the array limit`
`30`	`30`	`std::cout << array.at(5) << '\n';`
`31`	`31`	`}`
`32`		`- catch (json::out_of_range& e)`
	`32`	`+ catch (const json::out_of_range& e)`
`33`	`33`	`{`
`34`	`34`	`std::cout << e.what() << '\n';`
`35`	`35`	`}`