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.

Sign up for GitHub

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

Jump to bottom

Fix JavaDoc errors and warnings. #710

Merged
merged 6 commits into from
Aug 7, 2013
Merged

Fix JavaDoc errors and warnings. #710

merged 6 commits into from
Aug 7, 2013

Conversation

stefanbirkner
Copy link
Contributor

No description provided.

kcooney
kcooney reviewed Jul 31, 2013
View reviewed changes
build.xml
@@ -144,7 +144,6 @@
version="false"
use="false"
windowtitle="JUnit API"
stylesheetfile="stylesheet.css"
Copy link
Member

Choose a reason for hiding this comment

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

why are you deleting stylesheet.css?

Copy link
Contributor

Choose a reason for hiding this comment

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

The CSS moved to another folder. Not in root.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The current stylesheet does not work with JavaDoc generated by Oracle's Java7 javadoc. Somebody has to write a new stylesheet.

Copy link
Member

Choose a reason for hiding this comment

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

Let's update this line to use src/main/javadoc/stylesheet.css. If that stylesheet has problems, we'll can fix them in a different pull.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I have to restore the stylesheet. This will be done in the final rebase, when everything else is done.

@kcooney
Copy link
Member

kcooney commented Jul 31, 2013

Thanks for the contribution!

@stefanbirkner
Copy link
Contributor Author

I fixed all issues from the code review except the stylesheet stuff. If everything beside the stylesheet is fine, I would start to rebase the commit and fix the stylesheet commit.

@dsaff
Copy link
Member

dsaff commented Aug 6, 2013

Everything looks good modulo reworking the stylesheet. Thanks!

@stefanbirkner
Fix path to JavaDoc style sheet.
2d8f404
@stefanbirkner
Rewrite JavaDoc of ExcludeCategories.createFilter(Class<?>...).
31c422f 
Remove internal details of the created filter and describe its behaviour instead.
@stefanbirkner
Rewrite JavaDoc of IncludeCategories.createFilter(Class<?>...).
1064471 
Remove internal details of the created filter and describe its behaviour instead.
@stefanbirkner
Simplify JavaDoc of RunNotifier.fireTestFinished(...).
e0726d3
@stefanbirkner
Remove JavaDoc reference to test class.
0fac8c9 
The test class is no available by JavaDoc.
@stefanbirkner
Clean up JavaDoc of JUnit38ClassRunner.getAnnotations(...).
5a6d47c 
Remove empty return and add description of the parameter.
@stefanbirkner
Copy link
Contributor Author

The pull request is ready to be merged.

dsaff pushed a commit that referenced this pull request Aug 7, 2013
Merge pull request #710 from stefanbirkner/javadoc
bc2a68c 
Fix JavaDoc errors and warnings.
@dsaff dsaff merged commit bc2a68c into junit-team:master Aug 7, 2013
@dsaff
Copy link
Member

dsaff commented Aug 7, 2013

Thanks!

@stefanbirkner stefanbirkner deleted the javadoc branch August 8, 2013 05:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@stefanbirkner @kcooney @dsaff @Tibor17