Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Fill API Documentation #30

Merged
merged 39 commits into from
Jan 19, 2023
Merged

Fill API Documentation #30

merged 39 commits into from
Jan 19, 2023

Conversation

threeal
Copy link
Owner

@threeal threeal commented Jan 18, 2023 •
edited
Loading

Fill the Doxygen API documentation across whole structs and classes.

@threeal threeal added the docs label Jan 18, 2023
@threeal threeal self-assigned this Jan 18, 2023
@threeal
fill API docs and test for Err::Err(const char*)
60c82ce
@threeal
add OK comment when calling assert function in the code snippets
2fff05c
@threeal
fill API docs and test for Err::Err(const ErrStream&)
7bb7eee
@threeal
group test code snippet by structs
64ef2d1
@threeal
modify code snippet example in the res::Err constructors
dd99b82
@threeal
fill API docs and test for res::Err
7238978
@threeal
remove Ok::Ok()
0c7aecd
@threeal
fill API docs and test for res::Ok
348d1ed
@threeal
fill API docs and test for res::ErrStream
0f8a65d
@threeal
audit wording and style in include/result/err.hpp
4da541b
@threeal
fill API docs and test for res::Result
87364a6
@threeal
fill API docs and test for res::ResultOf
fb730fe
@threeal
audit API docs and test for res::Result
d87142c
@threeal
separate utils into each own page
3c90b31
@threeal
restructure api_documentation into api_docs
5723498
@threeal
ignore dot prefixed file, except git
8c69ad4
@threeal
fill API docs and test for Result::Result()
4e4375b
@threeal
fill API docs and test for Result::Result(const Ok&)
412854a
@threeal
fill API docs and test for Result::Result(const Err&)
1561282
@threeal
fill API docs and test for Result::Result(const ErrStream&)
fef5abe
@threeal
fill API docs for bool Result::is_ok() and bool Result::is_err()
8784800
@threeal
fill API docs and test for Err Result::unwrap_err()
c0b38b2
@threeal
separate test for unwrap_err() function into 2 sections
301818f
@threeal
fill API docs and test for ResultOr::ResultOr() constructor
3b30fc4
@threeal threeal marked this pull request as ready for review January 19, 2023 10:57
@threeal threeal merged commit 6dfd4f2 into main Jan 19, 2023
@threeal threeal deleted the fill-api-docs branch January 19, 2023 11:00
@threeal threeal mentioned this pull request Mar 14, 2023
Merged
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@threeal threeal

Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@threeal