You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2015/12/20 02:15:27 UTC
svn commit: r1720984 - in
/maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src:
main/java/org/apache/maven/doxia/tools/SiteTool.java site/apt/usage.apt
Author: hboutemy
Date: Sun Dec 20 01:15:27 2015
New Revision: 1720984
URL: http://svn.apache.org/viewvc?rev=1720984&view=rev
Log:
improved documentation
Modified:
maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/usage.apt
Modified: maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java?rev=1720984&r1=1720983&r2=1720984&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java Sun Dec 20 01:15:27 2015
@@ -133,6 +133,7 @@ public interface SiteTool
* @return the <code>DecorationModel</code> object corresponding to the <code>site.xml</code> file with some
* interpolations.
* @throws SiteToolException if any
+ * @since 1.7, was previously with other parameter types and order
*/
DecorationModel getDecorationModel( File siteDirectory, Locale locale, MavenProject project,
List<MavenProject> reactorProjects, ArtifactRepository localRepository,
@@ -160,6 +161,7 @@ public interface SiteTool
*
* @param locales A comma separated list of locales
* @return a list of <code>Locale</code>, which at least contains the Maven default locale which is english
+ * @since 1.7, was previously getAvailableLocales(String)
*/
List<Locale> getSiteLocales( String locales );
Modified: maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/usage.apt
URL: http://svn.apache.org/viewvc/maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/usage.apt?rev=1720984&r1=1720983&r2=1720984&view=diff
==============================================================================
--- maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/usage.apt (original)
+++ maven/doxia/doxia-sitetools/trunk/doxia-integration-tools/src/site/apt/usage.apt Sun Dec 20 01:15:27 2015
@@ -52,7 +52,7 @@ public class YourOwnMojo extends Abstrac
public someMethod()
{
- List localesList = siteTool.getAvailableLocales( locales );
+ List localesList = siteTool.getSiteLocales( locales );
String relativePath = siteTool.getRelativePath( "C:/foo/child",
"C:/foo/master" );
...