Author: cziegeler
Date: Wed Dec 30 07:58:28 2015
New Revision: 1722281
URL: http://svn.apache.org/viewvc?rev=1722281&view=rev
Log:
javadoc updates
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java?rev=1722281&r1=1722280&r2=1722281&view=diff
==============================================================================
---
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java
(original)
+++
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderDTO.java
Wed Dec 30 07:58:28 2015
@@ -25,12 +25,13 @@ public class ResourceProviderDTO {
/**
* The name of the resource provider.
- * Optional might be null.
+ * Optional might be {@code null}.
*/
public String name;
/**
* The path of the resource provider.
+ * This is never {@code null}.
*/
public String path;
@@ -41,6 +42,7 @@ public class ResourceProviderDTO {
/**
* The auth handling for this provider.
+ * This is never {@code null}.
*/
public AuthType authType;
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java?rev=1722281&r1=1722280&r2=1722281&view=diff
==============================================================================
---
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java
(original)
+++
sling/trunk/bundles/api/src/main/java/org/apache/sling/api/resource/runtime/dto/ResourceProviderFailureDTO.java
Wed Dec 30 07:58:28 2015
@@ -21,7 +21,8 @@ package org.apache.sling.api.resource.ru
/**
* Represents a failed {@code
org.apache.sling.spi.resource.provider.ResourceProvider}.
* If the provider is failed, some of the properties of the {@link
ResourceProviderDTO}
- * might be missing or invalid.
+ * might be missing or invalid, e.g. {@link ResourceProviderDTO#path} might
contain
+ * the empty path.
*/
public class ResourceProviderFailureDTO extends ResourceProviderDTO {
