You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by eg...@apache.org on 2003/08/21 12:29:14 UTC

cvs commit: cocoon-lenya/src/java/org/apache/lenya/cms/publication DocumentBuilder.java

egli        2003/08/21 03:29:14

  Modified:    src/java/org/apache/lenya/cms/publication
                        DocumentBuilder.java
  Log:
  Javadoc fixes.
  
  Revision  Changes    Path
  1.6       +11 -6     cocoon-lenya/src/java/org/apache/lenya/cms/publication/DocumentBuilder.java
  
  Index: DocumentBuilder.java
  ===================================================================
  RCS file: /home/cvs/cocoon-lenya/src/java/org/apache/lenya/cms/publication/DocumentBuilder.java,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- DocumentBuilder.java	20 Aug 2003 15:05:11 -0000	1.5
  +++ DocumentBuilder.java	21 Aug 2003 10:29:14 -0000	1.6
  @@ -61,12 +61,12 @@
    *
    * @author andreas
    *
  - * To change the template for this generated type comment go to
  - * Window>Preferences>Java>Code Generation>Code and Comments
    */
   public interface DocumentBuilder {
  +
       /**
        * Builds a document.
  +     * 
        * @param publication The publication the document belongs to.
        * @param url The URL of the form /{publication-id}/{area}/{document-id}{language-suffix}.{extension}.
        * @return A document.
  @@ -76,7 +76,8 @@
           throws DocumentBuildException;
       
       /**
  -     * Checks if a URL corresponds to a CMS docuemnt.
  +     * Checks if an URL corresponds to a CMS document.
  +     * 
        * @param publication The publication the document belongs to.
        * @param url The URL of the form /{publication-id}/...
        * @return A boolean value.
  @@ -86,7 +87,9 @@
           throws DocumentBuildException;
           
   	/**
  -	 * builds a url corresponding to a cms document from the publication, the area, the document id, the language
  +	 * Builds an URL corresponding to a cms document from the publication, 
  +     * the area, the document id and the language
  +     * 
   	 * @param publication The publication the document belongs to.
   	 * @param area The area the document belongs to.
   	 * @param documentid The document id of the document.
  @@ -96,7 +99,9 @@
   	String buildCanonicalUrl(Publication publication, String area, String documentid, String language);
           
   	/**
  -	 * builds a url corresponding to a cms document from the publication, the area, the document id
  +	 * Builds an URL corresponding to a cms document from the publication, 
  +     * the area and the document id
  +     * 
   	 * @param publication The publication the document belongs to.
   	 * @param area The area the document belongs to.
   	 * @param documentid The document id of the document.
  
  
  

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