diff --git a/index.html b/index.html index d1dc251..c0f6c6a 100644 --- a/index.html +++ b/index.html @@ -136,16 +136,20 @@
Result-CPP is a C++ library that provides a Result<T, E>
type, which can be used to return and propagate errors. It's inspired by Rust's std::Result
type.
Result-CPP is a C++ library that provides a Result<T, E>
type, which can be used to return and propagate errors. It's inspired by Rust's std::Result
type. It's a header-only library, so you can just copy the result.h
file into your project and start using it. Or you can use it as a git submodule. Or fetch it with FetchContent if you're using CMake.
You can find the documentation here.
+It's auto generated with Doxygen by GitHub Actions and hosted on GitHub Pages. It uses the Doxygen Awesome theme, that I customized to use Tokyo Night palette.
+Result<T, E>
type for returning and propagating errors.Ok
and Err
static methods for creating successful and unsuccessful Result
objects respectively.is_ok
and is_err
methods for checking if the Result
is successful or unsuccessful.unwrap
and unwrap_err
methods for extracting the value or error from the Result
.unwrap
, unwrap_or
and unwrap_err
methods for extracting the value or error from the Result
.I'm not planning to write any more features for this library, but I will gladly accept any pull requests that add new features or fix bugs.
+ diff --git a/navtreedata.js b/navtreedata.js index c5ae3df..8793836 100644 --- a/navtreedata.js +++ b/navtreedata.js @@ -26,8 +26,10 @@ var NAVTREE = [ [ "Result C++", "index.html", [ [ "result-cpp", "index.html", [ - [ "Features", "index.html#autotoc_md1", null ], - [ "Usage", "index.html#autotoc_md2", null ] + [ "Documentation", "index.html#autotoc_md1", null ], + [ "Features", "index.html#autotoc_md2", null ], + [ "Usage", "index.html#autotoc_md3", null ], + [ "Contributing", "index.html#autotoc_md4", null ] ] ], [ "Classes", "annotated.html", [ [ "Class List", "annotated.html", "annotated_dup" ], diff --git a/navtreeindex0.js b/navtreeindex0.js index 0aa0338..fea51e0 100644 --- a/navtreeindex0.js +++ b/navtreeindex0.js @@ -32,6 +32,8 @@ var NAVTREEINDEX0 = "index.html":[], "index.html#autotoc_md1":[0,0], "index.html#autotoc_md2":[0,1], +"index.html#autotoc_md3":[0,2], +"index.html#autotoc_md4":[0,3], "pages.html":[], "result_8h.html":[2,0,0,0], "result_8h_source.html":[2,0,0,0]