You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tamaya.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/04/30 12:54:00 UTC
[jira] [Commented] (TAMAYA-154) Fix javadoc issues before releasing
[ https://issues.apache.org/jira/browse/TAMAYA-154?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16458544#comment-16458544 ]
ASF GitHub Bot commented on TAMAYA-154:
---------------------------------------
GitHub user acoburn opened a pull request:
https://github.com/apache/incubator-tamaya-sandbox/pull/4
Fix javadocs issues
Addresses TAMAYA-154
This adds some missing javadoc parameters.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/acoburn/incubator-tamaya-sandbox TAMAYA-154
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-tamaya-sandbox/pull/4.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 #4
----
commit dbadcd6d9be959ee8d2e54907a89a2dd9348593b
Author: Aaron Coburn <ac...@...>
Date: 2018-04-30T12:52:02Z
Fix javadocs issues
Addresses TAMAYA-154
----
> Fix javadoc issues before releasing
> -----------------------------------
>
> Key: TAMAYA-154
> URL: https://issues.apache.org/jira/browse/TAMAYA-154
> Project: Tamaya
> Issue Type: Improvement
> Affects Versions: 0.3-incubating
> Reporter: Philipp Ottlinger
> Assignee: Philipp Ottlinger
> Priority: Major
> Fix For: 0.4-incubating
>
> Attachments: 20160423minorJavadocFixes.diff
>
>
> In order to provide a feature-complete Javadoc it should be generated without warnings. In order to see the warnings, run:
> {code}
> mvn clean javadoc:javadoc > jvdoc.txt
> cat jvdoc.txt | grep warn
> {code}
> h2. Little helpers
> * http://stackoverflow.com/questions/541920/multiple-line-code-example-in-javadoc-comment#542142
> * http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)