[SHRINKRES-340] fix typos, grammar, errors and add missing descriptions in javadoc #202
Conversation
| @@ -56,7 +56,7 @@ class Invokable { | |||
| * | |||
| * @param cl classloader to be used | |||
| * @param classTypeName fully qualified class name | |||
| * @return | |||
| * @return the loaded {@code Class} object | |||
| * @param version | ||
| * @param packaging | ||
| * @param classifier | ||
| * @param groupId The group ID of the Maven coordinate. |
There was a problem hiding this comment.
It looks correct to me, so the descriptions are lined up for better readability in IDE
| * @param artifactId The artifact ID of the Maven coordinate. | ||
| * @param version The version of the Maven coordinate. | ||
| * @param packaging The packaging type of the Maven coordinate. Defaults to {@link PackagingType#JAR} if not specified. | ||
| * @param classifier The classifier of the Maven coordinate. If not specified, it defaults to the classifier derived from the packaging type. |
There was a problem hiding this comment.
Here the extra space is missing
xjusko
force-pushed
the
reviews-and-fix-javadoc-error-and-typos
branch
from
918ff80 to
d692533
Compare
|
Thanks @petrberan , I missed those when I was reviewing my changes, thanks, it should be fixed now. |
| @@ -243,7 +243,7 @@ public void pomRemoteBasedDependencies() { | |||
|
|
|||
| /** | |||
| * Tests resolving a version from pom.xml which has non-default scope | |||
| * https://issues.jboss.org/browse/SHRINKRES-103 | |||
| * <a href="https://issues.jboss.org/browse/SHRINKRES-103">SHRINKRES-103</a> | |||
| @@ -19,7 +19,7 @@ | |||
| import org.jboss.shrinkwrap.resolver.api.maven.ScopeType; | |||
|
|
|||
| /** | |||
| * Applies the default behavior exhibited by Maven with regards to handling transitive dependencies during resolution. | |||
| * Applies the default behavior exhibited by Maven in regard to handling transitive dependencies during resolution. | |||
There was a problem hiding this comment.
What about "Applies the default behavior exhibited by Maven in handling transitive dependencies during resolution."
|
I'm not a fan of those extra offset params in the javadoc. It may look good, but it's harder to maintain. Left some comments, otherwise looks good! |
|
Also please don't forget to link this PR to the JIRA issue @xjusko ! |
xjusko
force-pushed
the
reviews-and-fix-javadoc-error-and-typos
branch
3 times, most recently
from
9e3df82 to
92c6170
Compare
|
@petrberan, The errors should be fixed, I also included changing all SHRINKRES jira links in Javadoc to HTML links. Regarding the indentation in Javadoc, I removed all the unnecessary whitespace as you suggested. |
xjusko
force-pushed
the
reviews-and-fix-javadoc-error-and-typos
branch
from
92c6170 to
b41eed3
Compare
xjusko
force-pushed
the
reviews-and-fix-javadoc-error-and-typos
branch
from
b41eed3 to
1a53395
Compare
|
Great job @xjusko , thank you |
https://issues.redhat.com/browse/SHRINKRES-340