You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by ts...@apache.org on 2005/05/16 14:58:47 UTC
svn commit: r170379 -
/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentType.java
/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilder.java
/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilderImpl.java
Author: tschlabach
Date: Mon May 16 05:58:47 2005
New Revision: 170379
URL: http://svn.apache.org/viewcvs?rev=170379&view=rev
Log:
Improved some JavaDoc comments
Modified:
lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentType.java
lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilder.java
lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilderImpl.java
Modified: lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentType.java
URL: http://svn.apache.org/viewcvs/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentType.java?rev=170379&r1=170378&r2=170379&view=diff
==============================================================================
--- lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentType.java (original)
+++ lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentType.java Mon May 16 05:58:47 2005
@@ -27,7 +27,26 @@
/**
- * A document type.
+ * <p>
+ * Represents a resource type (formerly known as document type)
+ * which is usually configured in the file <code>doctypes.xconf</code>.
+ * </p>
+ *
+ * <p>
+ * Has no behaviour but only holds:
+ * </p>
+ * <ul>
+ * <li>the name of the resource type (xhtml, rss, ...)</li>
+ * <li>the linkAttributeXPaths</li>
+ * <li>the location of a template used to instantiate new resources of this type</li>
+ * <li>the schema defintion for the ressource type</li>
+ * <li>the workflow file</li>
+ * <li>the NodeCreatorInterface which is used to create a new
+ * document with this doctype</li>
+ * </ul>
+ *
+ * <p>Instances of DocumentType are instantiated by a {@link DocumentTypeBuilder}.</p>
+ *
*/
public class DocumentType extends AbstractLogEnabled {
/**
Modified: lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilder.java
URL: http://svn.apache.org/viewcvs/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilder.java?rev=170379&r1=170378&r2=170379&view=diff
==============================================================================
--- lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilder.java (original)
+++ lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilder.java Mon May 16 05:58:47 2005
@@ -19,7 +19,7 @@
/**
- * Interface for a builder for document types.
+ * Interface for a builder that builds {@link DocumentType} objects.
*
* Note that the term "document types" is deprecated, and
* will be replaced by the term "resource types" in the future.
Modified: lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilderImpl.java
URL: http://svn.apache.org/viewcvs/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilderImpl.java?rev=170379&r1=170378&r2=170379&view=diff
==============================================================================
--- lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilderImpl.java (original)
+++ lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentTypeBuilderImpl.java Mon May 16 05:58:47 2005
@@ -36,11 +36,16 @@
import org.xml.sax.SAXException;
/**
- * A service for building an instance of DocumentType.
+ * Avalon Service for building an instance of {@link DocumentType} using information
+ * from the <code>doctypes.xconf</code> configuration file.
*
- * Since this service is very frequently used, it is implemented as a poolable service. Furthermore,
- * the instances are cached, to avoid re-reading configuration unless necessary (that is, when the
- * configuration file has changed).
+ * <p>
+ * Since this service is very frequently used, it is implemented as a poolable service.
+ * </p>
+ * <p>
+ * Furthermore, the instances are cached, to avoid re-reading configuration unless the
+ * configuration file has changed.
+ * </p>
*
* @version $Id$
*/
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org