You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2015/12/19 18:02:46 UTC

[jira] [Commented] (MJAVADOC-385) Fix documentation of feature

    [ https://issues.apache.org/jira/browse/MJAVADOC-385?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15065431#comment-15065431 ] 

ASF GitHub Bot commented on MJAVADOC-385:
-----------------------------------------

GitHub user Stephan202 opened a pull request:

    https://github.com/apache/maven-plugins/pull/74

    Fix for MJAVADOC-385

    This fixes the `maven-javadoc-plugin` documentation for the `<additionalDependencies>` feature. The changes made are exactly those described in [MJAVADOC-385](https://issues.apache.org/jira/browse/MJAVADOC-385). Some integration test paths are updated as well. I verified it all still works. 

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/Stephan202/maven-plugins MJAVADOC-385

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/maven-plugins/pull/74.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 #74
    
----
commit f202cd38d8b722ad7d498b40be820fc5da5cdd2a
Author: Stephan Schroevers <st...@teampicnic.com>
Date:   2015-12-19T16:29:20Z

    Fix <additionalDependencies> feature documentation
    
    Resolves MJAVADOC-385.

----


> Fix documentation of <additionalDependencies> feature
> -----------------------------------------------------
>
>                 Key: MJAVADOC-385
>                 URL: https://issues.apache.org/jira/browse/MJAVADOC-385
>             Project: Maven Javadoc Plugin
>          Issue Type: Documentation
>    Affects Versions: 2.9.1
>            Reporter: Stephan Schroevers
>
> The feature introduced with MJAVADOC-322 had a typo. Code-wise, this was fixed in MJAVADOC-334. However, the documentation on the website still has the typo. So when I copy-pasted it, it didn't work...
> Anyway, the documentation can be fixed as follows: 
> {noformat}
> $ find . -type f -print0 | xargs -0 sed -i 's,additionnal,additional,g'
> $ mv ./src/site/apt/examples/additionnal-dependencies.apt.vm ./src/site/apt/examples/additional-dependencies.apt.vm
> $ mv ./src/it/additionnal-dependencies-non-aggregate ./src/it/additional-dependencies-non-aggregate
> $ mv ./src/it/additionnal-dependencies ./src/it/additional-dependencies
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)