Generate doxygen documentation and publish on github pages + code coverage published on coveralls.io #76
Conversation
|
https://prince-chrismc.github.io/jwt-cpp/ for a preview |
* adding coverage testing surprisingly: Overall coverage rate: lines......: 80.6% (519 of 644 lines) functions..: 92.5% (235 of 254 functions) * Update coverage.yml
|
My intention was to separate these two items but github was not liking my attempt... One potential issue is this uses GitHub action (instead of continuing with travis) the integration with from the new actions makes all of this a lot easier. |
prince-chrismc
changed the title
|
I think its fine to have them as one PR. A doxygen documentation is also good, but I think we might need to start documenting stuff for it to be trully usefull. Sidenote: I do intend to rewrite most of the internals to use std::error_code instead of exceptions, as well as providing non throwing overloads for all public functions. |
README.md
Outdated
| @@ -2,6 +2,7 @@ | |||
|
|
|||
| [](https://app.codacy.com/app/Thalhammer/jwt-cpp?utm_source=github.com&utm_medium=referral&utm_content=Thalhammer/jwt-cpp&utm_campaign=Badge_Grade_Settings) | |||
| [](https://travis-ci.com/Thalhammer/jwt-cpp) | |||
| [](https://coveralls.io/github/prince-chrismc/jwt-cpp?branch=master) | |||
There was a problem hiding this comment.
This needs to be changed to point to the original repo onve merged (or right before).
|
I've only started using them recently, they have been a pleasure! Error handling is certainly the big one, it might be worth looking into fuzzing to see how that goes. I see your error_codes have been an idea for while, certainly useful 👍 |
Since this library is used as a part of API security I think its only fair to expect a high level of quality.
Having documentation more accessibly helps prevent implementation mistakes.
Code coverage will help highlight short comings where improvements can be made.
closes #41
README.mdor project