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

Updating documentation with new functionality #28

Open
arstrube opened this issue Feb 25, 2016 · 4 comments
Open

Updating documentation with new functionality #28

arstrube opened this issue Feb 25, 2016 · 4 comments

Comments

@arstrube
Copy link
Contributor

@basvodde - I am currently working on a PR to document the new functionality that will be part of CppUTest v3.8 (and also update some that has always been missing)

  1. You can view the updated pages at http://arstrube.github.io.
  2. Would it be possible for you to link cpputest with Coveralls? It doesn't really make sense to display coverage from my fork, which is the only thing I can do right now. I really think the badge should be here.
  3. The Doxygen section is not really useful at all, in my opinion. Improving it would involve a lot of work (and probably some comments in the code) so my suggestion is to remove the link:
    • It does not include CppUTestExt
    • It displays all the internal stuff nobody is interested in
    • It does not give a good summary of what would be truly important for a user (e.g. Testharness.h, Testharness_c.h, CommandlineTestRunner.h, UtestMacro.h MockSupport.h, Mocksupport_c.h, MockExpectedCall.h and MockActualCall.h and probably a few others), especially as the links to source file are 404.
@arstrube
Copy link
Contributor Author

arstrube commented Mar 3, 2016

@basvodde No. 2 is still open. I don't think it's a good idea if the badge points to my fork, but it seems that cpputest/cpputest ins not properly hooked up to Appveyor, and the badge stays grey.

Could you perhaps make sure the proper connection is made in Appveyor? Then let me know and I'll change the badge.

@basvodde
Copy link
Member

basvodde commented Mar 4, 2016

Uhm

@basvodde
Copy link
Member

basvodde commented Mar 4, 2016

How to do that?

@arstrube
Copy link
Contributor Author

arstrube commented Mar 4, 2016

Go to https://coveralls.io/.
Click "Sign up for free".
Click "Github signup".
As of this point, I can't help you because it knows me and I don't get the page you would. Essentially, you sign up with the cpputest Github account, and you add the repository to Coveralls.
You have to authorize it at the Github end, but that page will come up automatically.
That's it.

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

No branches or pull requests

2 participants