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.

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

Added Doxygen documentation for all files #28

Merged
merged 1 commit into from
Sep 7, 2019

Conversation

FloatingFowl
Copy link

@FloatingFowl FloatingFowl commented May 3, 2018

All class (public) members have been documented (including the operators) along with the other helper/utility functions present in include/functions. Opening docs/html/index.html in a browser will give the documentation.

To regenerate the documentation, run cd docs; doxygen Doxyfile from the root directory after installing Doxygen.

Currently the documentation must be updated manually. The next step can be to integrate it with Travis.CI and possibly link to the documentation from the repo website.

Closes #4.

@codecov
Copy link

codecov bot commented May 3, 2018

Codecov Report

Merging #28 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master    #28   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          13     13           
  Lines         536    536           
=====================================
  Hits          536    536
Impacted Files Coverage Δ
include/operators/relational.hpp 100% <ø> (ø) ⬆️
include/operators/io_stream.hpp 100% <ø> (ø) ⬆️
include/functions/random.hpp 100% <ø> (ø) ⬆️
include/operators/increment_decrement.hpp 100% <ø> (ø) ⬆️
include/operators/binary_arithmetic.hpp 100% <ø> (ø) ⬆️
include/BigInt.hpp 100% <ø> (ø) ⬆️
include/functions/conversion.hpp 100% <ø> (ø) ⬆️
include/functions/math.hpp 100% <ø> (ø) ⬆️
include/operators/unary_arithmetic.hpp 100% <ø> (ø) ⬆️
include/operators/assignment.hpp 100% <ø> (ø) ⬆️
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 69dd72f...e2d2bf1. Read the comment docs.

Copy link
Owner

@faheel faheel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FloatingFowl Thanks for adding Doxygen documentation! I think that only the Doxyfile should be committed, as the rest of the documentation files can be generated right before they're published after a successful CI build as you suggested.

@faheel faheel added the docs Documentation label May 3, 2018
Deleted /docs/html and Updated .gitignore

Added documentation for all files
@FloatingFowl
Copy link
Author

@faheel The doc files have been removed

@faheel
Copy link
Owner

faheel commented May 4, 2018

I'm quite busy currently so I'll only be able to review the updated documentation in detail by the end of next week (May 11).

@faheel faheel force-pushed the master branch 2 times, most recently from 6bf4812 to 69dd72f Compare May 14, 2018 13:38
@faheel faheel changed the base branch from master to docs September 7, 2019 20:49
@faheel faheel merged commit 395de54 into faheel:docs Sep 7, 2019
@faheel
Copy link
Owner

faheel commented Sep 7, 2019

@FloatingFowl Thanks a lot for your work on this! I've been working on other projects and had forgotten about this PR, so I apologize for merging it after such a long time. Thank you for your patience 🙂

@faheel
Copy link
Owner

faheel commented Sep 7, 2019

I've merged this in the docs branch for now, which will be merged into master after a few more changes (that are being done in PR #50).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants