Repository navigation
Conversation
- README: fix minigmp version (6.1.2 -> 6.3.0 after #33), add Documentation section linking to the GitHub Pages site, add License section (LGPL-3.0), fix typos (Power by, incuding, do not required, makes as) - pages/index.html: refresh landing page to match the updated README (minigmp 6.3.0, drop removed qmake references, fix removed #build anchor, add explicit README / API Reference links) Closes #36
Closed
- Full human-readable Doxygen comments for the whole BigInt class in src/bigint.h (class overview, @code example, @snippet of the full example, brief+detailed docs for every public member; BigInt::log documented as not implemented). - New examples/bigint_usage_example.cpp: complete standalone-compilable usage example (verified: compiles and runs against the library sources), with // [usage] markers so the @snippet block extracts the program. - doxygen.conf: EXAMPLE_PATH=examples (standalone example page + Examples tab), IMAGE_PATH fixed to res, removed 14 obsolete tags -> doxygen exits 0 with 0 errors and 0 warnings. - README.md: banner moved below the description so the Doxygen main-page title is clean; link to the example file. - pages/index.html: quick-example section linking the example file and docs. - CMake Ninja Release rebuild OK; QtBigintTest 26/26 PASS.
Member
Author
|
Added the human-readable Doxygen documentation and the usage example requested in the review:
Verification: Doxygen 1.9.8 run exits 0 with 0 errors and 0 warnings; |
EndrII
reviewed
Oct 14, 2026
EndrII
approved these changes
Oct 14, 2026
Signed-off-by: Andrei Yankovich <endriipersonal@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates the README and brings the GitHub Pages site in sync with the current state of the library.
README.md
pages/index.html (GitHub Pages landing page)
#buildanchor →#include-cmakedoc/index.htmland deployed to GitHub Pages by the existingdeploy-docs.ymlworkflow on merge)Verification
tests/QtBigintTest: 26/26 PASSCloses #36