svn commit: r170384 - /lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentManager.java

[ts...@apache.org]

Author: tschlabach
Date: Mon May 16 06:21:04 2005
New Revision: 170384

URL: http://svn.apache.org/viewcvs?rev=170384&view=rev
Log:
some minor changes to the Javadocs

Modified:
    lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentManager.java

Modified: lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentManager.java
URL: http://svn.apache.org/viewcvs/lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentManager.java?rev=170384&r1=170383&r2=170384&view=diff
==============================================================================
--- lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentManager.java (original)
+++ lenya/trunk/src/java/org/apache/lenya/cms/publication/DocumentManager.java Mon May 16 06:21:04 2005
@@ -59,7 +59,8 @@
     void copyToArea(DocumentSet documentSet, String destinationArea) throws PublicationException;
 
     /**
-     * Adds a document to the publication.
+     * Creates a new document in the same publication the <code>parentDocument</code>
+     * belongs to with the given parameters:
      *
      * @param parentDocument The parent document.
      * @param newDocumentNodeName the name of the node representing the new document
@@ -67,10 +68,14 @@
      * @param documentTypeName the document type (aka resource type) of the new document 
      * @param language language of the new document
      * @param navigationTitle navigation title
-     * @param initialContentsURI an URI from which initial contents for the new document can be read. Optional parameter; may be set to null, in which case the default initial sample will be used.
-     * @param nodeType the node type, as defined by the constants in NodeCreatorInterface
+     * @param initialContentsURI an URI from which initial contents for the 
+     * new document can be read. Optional parameter; may be set to <code>null</code>, 
+     * in which case the default initial sample as configured in 
+     * <code>doctypes.xconf</code> will be used.
+     * @param nodeType the node type, as defined by the constants in {@link org.apache.lenya.cms.authoring.NodeCreatorInterface NodeCreatorInterface}
      * @param parameters any parameters the caller needs to pass to the creator
      * @param useSiteManager set to true if the site manager is used in the publication; if set the site manager will be notified about the new document
+     * 
      * @throws DocumentBuildException if the document can not be created
      * @throws PublicationException if the document is already contained.
      */



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org