You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@edgent.apache.org by Cazen <gi...@git.apache.org> on 2016/06/22 03:02:45 UTC
[GitHub] incubator-quarks pull request #147: [QUARKS-205][WIP] Create gradle Javadoc ...
GitHub user Cazen opened a pull request:
https://github.com/apache/incubator-quarks/pull/147
[QUARKS-205][WIP] Create gradle Javadoc task
WIP - All javadoc files are generated but something phrase are different when running diff. I will check it soon
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/Cazen/incubator-quarks QUARKS-205
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-quarks/pull/147.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #147
----
commit ed9c773b40a84c9204b0c3d13dfc08ea9457ec34
Author: cazen <ca...@apache.org>
Date: 2016-06-22T02:56:11Z
init javadoc work
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request #147: [QUARKS-205][WIP] Create gradle Javadoc ...
Posted by Cazen <gi...@git.apache.org>.
Github user Cazen commented on a diff in the pull request:
https://github.com/apache/incubator-quarks/pull/147#discussion_r68355123
--- Diff: build.gradle ---
@@ -28,6 +28,14 @@ ext.ext_classpath = ['com.google.code.gson:gson:2.2.4',
'io.dropwizard.metrics:metrics-core:3.1.2']
ext.target_dir = "$distsDir"
ext.target_java8_dir = "${ext.target_dir}/java8"
+ext.target_javadoc_dir = "${ext.target_dir}/docs/javadoc"
+
+if (JavaVersion.current().isJava8Compatible()) {
+ tasks.withType(Javadoc) {
+ options.addStringOption('Xdoclint:none', '-quiet')
--- End diff --
Hi @dlaboss Thank you for review!
It looks only few warning in javadoc. I removed Xdoclint:none option.
I will create another jira issue for remove these warnings
And, except for a few differences, the results of Javadoc of ant and gradle are almost matches.(compare with ```diff -r build/distributions/docs/javadoc/ target/docs/javadoc/```)
The only thing I worry about is we could not see the JavaDoc that inherited from interface
(e.g ```diff -r build/distributions/docs/javadoc/quarks/connectors/file/FileWriterPolicy.html target/docs/javadoc/quarks/connectors/file/FileWriterPolicy.html```
And the ant output added description from interface like ```Description copied from interface: quarks.connectors.file.runtime.IFileWriterPolicy``` but gradle is not)
Unfortunately, I still have not found a way to solve this problem. I am still looking for a solution, but could you tell me if you know the related javadoc options?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request #147: [QUARKS-205][WIP] Create gradle Javadoc ...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-quarks/pull/147#discussion_r68319298
--- Diff: build.gradle ---
@@ -28,6 +28,14 @@ ext.ext_classpath = ['com.google.code.gson:gson:2.2.4',
'io.dropwizard.metrics:metrics-core:3.1.2']
ext.target_dir = "$distsDir"
ext.target_java8_dir = "${ext.target_dir}/java8"
+ext.target_javadoc_dir = "${ext.target_dir}/docs/javadoc"
+
+if (JavaVersion.current().isJava8Compatible()) {
+ tasks.withType(Javadoc) {
+ options.addStringOption('Xdoclint:none', '-quiet')
--- End diff --
Is Xdoclint:none still required? I did a lot of work cleaning up things but maybe I didn't get everything. Were there many complaints? If possible/sensible, it would seem better to just fix them. If that's a good idea but we really don't want to tackle that at this instant, please create another jira to track doing that after we finally convert to gradle.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request #147: [QUARKS-205] Create gradle Javadoc task
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-quarks/pull/147
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-quarks pull request #147: [QUARKS-205][WIP] Create gradle Javadoc ...
Posted by dlaboss <gi...@git.apache.org>.
Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-quarks/pull/147#discussion_r68392547
--- Diff: build.gradle ---
@@ -28,6 +28,14 @@ ext.ext_classpath = ['com.google.code.gson:gson:2.2.4',
'io.dropwizard.metrics:metrics-core:3.1.2']
ext.target_dir = "$distsDir"
ext.target_java8_dir = "${ext.target_dir}/java8"
+ext.target_javadoc_dir = "${ext.target_dir}/docs/javadoc"
+
+if (JavaVersion.current().isJava8Compatible()) {
+ tasks.withType(Javadoc) {
+ options.addStringOption('Xdoclint:none', '-quiet')
--- End diff --
Sorry, I don't know why the behavior might be different / why it was working in the ant build.
Unrelated to this particular problem but something to keep in mind: eventually we'll want to address QUARKS-152. Don't know if your current work / changes will help.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---