Skip to content
Permalink
Browse files

Minor fixes to JavaDoc.

Updated pom.xml.
  • Loading branch information...
jfendler committed Feb 21, 2016
1 parent 335ee28 commit 29a20e8c0dd6118470ac72f4ce477fd5bed6efbd
@@ -1,5 +1,4 @@
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.jensfendler</groupId>
<artifactId>ninja-sitemap</artifactId>
@@ -34,37 +34,37 @@
*/
public class SimpleSitemapRouteDetails implements SitemapRouteDetails {

public SimpleSitemapRouteDetails() {
}
public SimpleSitemapRouteDetails() {
}

/**
* @see com.jensfendler.ninjasitemap.SitemapRouteDetails#getLastModifiedDateForRoute(com.jensfendler.ninjasitemap.annotations.Sitemap,
* ninja.Route)
*/
@Override
public Date getLastModifiedDateForRoute(Route route, Sitemap sitemapAnnotation) {
// assume the page has just been updated
return new Date();
}
/**
* @see com.jensfendler.ninjasitemap.SitemapRouteDetails#getLastModifiedDateForRoute(ninja.Route,
* com.jensfendler.ninjasitemap.annotations.Sitemap)
*/
@Override
public Date getLastModifiedDateForRoute(Route route, Sitemap sitemapAnnotation) {
// assume the page has just been updated
return new Date();
}

/**
* @see com.jensfendler.ninjasitemap.SitemapRouteDetails#getPriorityForRoute(ninja.Route,
* com.jensfendler.ninjasitemap.annotations.Sitemap)
*/
@Override
public double getPriorityForRoute(Route route, Sitemap sitemap) {
// always use the default priority
return Sitemap.DEFAULT_PRIORITY;
}
/**
* @see com.jensfendler.ninjasitemap.SitemapRouteDetails#getPriorityForRoute(ninja.Route,
* com.jensfendler.ninjasitemap.annotations.Sitemap)
*/
@Override
public double getPriorityForRoute(Route route, Sitemap sitemap) {
// always use the default priority
return Sitemap.DEFAULT_PRIORITY;
}

/**
* @see com.jensfendler.ninjasitemap.SitemapRouteDetails#getChangeFrequencyForRoute(ninja.Route,
* com.jensfendler.ninjasitemap.annotations.Sitemap)
*/
@Override
public int getChangeFrequencyForRoute(Route route, Sitemap sitemap) {
// always use the default frequency
return Sitemap.DEFAULT_CHANGE_FREQUENCY;
}
/**
* @see com.jensfendler.ninjasitemap.SitemapRouteDetails#getChangeFrequencyForRoute(ninja.Route,
* com.jensfendler.ninjasitemap.annotations.Sitemap)
*/
@Override
public int getChangeFrequencyForRoute(Route route, Sitemap sitemap) {
// always use the default frequency
return Sitemap.DEFAULT_CHANGE_FREQUENCY;
}

}
@@ -37,7 +37,7 @@
* the {@link Sitemap} annotation.
* @return the default {@link Date} to use as value for "lastModified"
*/
public Date getLastModifiedDateForRoute(Route route, Sitemap sitemapAnnotation);
public Date getLastModifiedDateForRoute(Route route, Sitemap sitemapAnnotation);

/**
* If the {@link Sitemap#priority()} value is set to
@@ -20,6 +20,7 @@
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.jensfendler.ninjasitemap.SitemapMultiPageProvider;
import com.jensfendler.ninjasitemap.SitemapRouteDetails;

/**
@@ -76,12 +77,18 @@
* SitemapMultiPageProvider interface, to generate a set of pages from one
* route.
*
* @return
* @return the full class name of the {@link SitemapMultiPageProvider}
* implementation to use for this controller method
*/
String multiPageProvider() default NO_MULTIPAGE_PROVIDER;

/**
* The path to use for this (non-dynamic) route in the sitemap.
* Explicitly provide a path for the sitemap entry of this controller
* method. Note: setting this parameter only makes sense for non-dynamic
* routes.
*
* By default, this value will be automatically determined from the route's
* URI.
*
* @return the path (page name) to use in the sitemap.
*/
@@ -97,6 +104,8 @@
/**
* The change frequency of this page in the sitemap. Should be one of the
* frequency constants of the {@link Sitemap} annotation.
*
* @return the change frequency (in the range 0.0 to 1.0)
*/
int changeFrequency() default DEFAULT_CHANGE_FREQUENCY;

0 comments on commit 29a20e8

Please sign in to comment.
You can’t perform that action at this time.