FloatingFowl commented 6 years ago

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[bot] commented 6 years ago

Codecov Report

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

@@          Coverage Diff          @@
##           master    #28   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          13     13           
  Lines         536    536           
=====================================
  Hits          536    536

Impacted Files	Coverage Δ
include/operators/relational.hpp	`100% <ø> (ø)`	:arrow_up:
include/operators/io_stream.hpp	`100% <ø> (ø)`	:arrow_up:
include/functions/random.hpp	`100% <ø> (ø)`	:arrow_up:
include/operators/increment_decrement.hpp	`100% <ø> (ø)`	:arrow_up:
include/operators/binary_arithmetic.hpp	`100% <ø> (ø)`	:arrow_up:
include/BigInt.hpp	`100% <ø> (ø)`	:arrow_up:
include/functions/conversion.hpp	`100% <ø> (ø)`	:arrow_up:
include/functions/math.hpp	`100% <ø> (ø)`	:arrow_up:
include/operators/unary_arithmetic.hpp	`100% <ø> (ø)`	:arrow_up:
include/operators/assignment.hpp	`100% <ø> (ø)`	:arrow_up:
... 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.

FloatingFowl commented 6 years ago

@faheel The doc files have been removed

faheel commented 6 years ago

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 commented 5 years ago

@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 :slightly_smiling_face:

faheel commented 5 years ago

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).

faheel / BigInt

Added Doxygen documentation for all files #28

Codecov Report