Author: tchemit Date: 2010-05-10 11:56:17 +0200 (Mon, 10 May 2010) New Revision: 1947 Url: http://nuiton.org/repositories/revision/topia/1947 Log: fix javadoc Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/package-info.java trunk/topia-persistence/src/main/java/org/nuiton/topia/generator/TopiaRelationValidator.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/package-info.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/package-info.java 2010-05-10 09:40:32 UTC (rev 1946) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/framework/package-info.java 2010-05-10 09:56:17 UTC (rev 1947) @@ -23,23 +23,20 @@ * #L% */ /** - * Contains two interfaces, one {@link TopiaContextImplementor}for internal - * manipulations of {@link TopiaContext} and one {@link TopiaService}for topia - * services. This package contains also the main implementation {@link TopiaContextImpl} - * for both {@link TopiaContext} for final applications and - * {@link TopiaContextImplementor} for internal. + * Contains two interfaces, one {@link org.nuiton.topia.framework.TopiaContextImplementor} for internal + * manipulations of {@link org.nuiton.topia.TopiaContext} and one {@link org.nuiton.topia.framework.TopiaService} for topia + * services. This package contains also the main implementation {@link org.nuiton.topia.framework.TopiaContextImpl} + * for both {@link org.nuiton.topia.TopiaContext} for final applications and + * {@link org.nuiton.topia.framework.TopiaContextImplementor} for internal. * <p /> - * You can also use {@link TopiaQuery} class for query manipulation with - * {@link TopiaDAO}. + * You can also use {@link org.nuiton.topia.framework.TopiaQuery} class for query manipulation with + * {@link org.nuiton.topia.persistence.TopiaDAO}. * <p /> - * {@link TopiaUtil} is a helper class used for TopiaContext manipulations. + * {@link org.nuiton.topia.framework.TopiaUtil} is a helper class used for TopiaContext manipulations. * * @author fdesbois <fdesbois@codelutin.com> * @version $Id$ - * @see TopiaContext - * @see TopiaDAO + * @see org.nuiton.topia.TopiaContext + * @see org.nuiton.topia.persistence.TopiaDAO */ package org.nuiton.topia.framework; - -import org.nuiton.topia.persistence.TopiaDAO; -import org.nuiton.topia.TopiaContext; \ No newline at end of file Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/generator/TopiaRelationValidator.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/generator/TopiaRelationValidator.java 2010-05-10 09:40:32 UTC (rev 1946) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/generator/TopiaRelationValidator.java 2010-05-10 09:56:17 UTC (rev 1947) @@ -52,7 +52,6 @@ * <li>Toutes les relations ont des reverseAttribute</li> * </ul> * - * @author * @version $Id$ */ public class TopiaRelationValidator extends ObjectModelValidator { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java 2010-05-10 09:40:32 UTC (rev 1946) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntity.java 2010-05-10 09:56:17 UTC (rev 1947) @@ -79,7 +79,7 @@ @Deprecated String TOPIA_CREATE_DATE = "topiaCreateDate"; - /** @deprecated since 2.4 use {@link #VERSION} instead */ + /** @deprecated since 2.4 use {@link #ENTITY_VERSION} instead */ @Deprecated String TOPIA_VERSION = "topiaVersion"; @@ -92,27 +92,45 @@ /** Property name of the technical {@code version} of the entity */ String ENTITY_VERSION = "topiaVersion"; - /** @deprecated since 2.4 use {@link #getId()} instead */ + /** + * @return the id + * @deprecated since 2.4 use {@link #getId()} instead + */ @Deprecated String getTopiaId(); - /** @deprecated since 2.4 use {@link #setId(String)} instead */ + /** + * @param v the new id + * @deprecated since 2.4 use {@link #setId(String)} instead + */ @Deprecated void setTopiaId(String v); - /** @deprecated since 2.4 use {@link #getVersion()} instead */ + /** + * @return the entity version + * @deprecated since 2.4 use {@link #getEntityVersion()} instead + */ @Deprecated long getTopiaVersion(); - /** @deprecated since 2.4 use {@link #setVersion(long)} instead */ + /** + * @param v the new entity version + * @deprecated since 2.4 use {@link #setEntityVersion(long)} instead + */ @Deprecated void setTopiaVersion(long v); - /** @deprecated since 2.4 use {@link #getCreateDate()} */ + /** + * @return the creation date of the entity + * @deprecated since 2.4 use {@link #getCreateDate()} + */ @Deprecated Date getTopiaCreateDate(); - /** @deprecated since 2.4 use {@link #setCreateDate(Date)} */ + /** + * @param topiaCreatedate the creation date of the entity + * @deprecated since 2.4 use {@link #setCreateDate(Date)} + */ @Deprecated void setTopiaCreateDate(Date topiaCreatedate); @@ -176,7 +194,7 @@ * Called just after object creation and initialisation each entity impl can * overide it to do something after creation * - * @throws TopiaException + * @throws TopiaException if any pb * @deprecated since 2.4 : don't really know is concrete usage, the needed * treatment can be directly done after creating the entity with * {@link TopiaDAO#create(Object...)} @@ -188,6 +206,7 @@ * @deprecated since 2.4 : context will no longer be keeped by the entity, * so it will be impossible to do such operation. Use {@link * TopiaDAO#update(TopiaEntity)} instead. + * @throws TopiaException if any pb */ @Deprecated void update() throws TopiaException; @@ -196,28 +215,29 @@ * @deprecated since 2.4 : context will no longer be keeped by the entity, * so it will be impossible to do such operation. Use {@link * TopiaDAO#delete(TopiaEntity)} instead. + * @throws TopiaException if any pb */ @Deprecated void delete() throws TopiaException; /** * @return all object that must be deleted if this object is deleted - * @throws TopiaException + * @throws TopiaException if any pb */ List<TopiaEntity> getComposite() throws TopiaException; /** * @return all object that are aggregate with this instance, aggreate object * are not removed automaticaly - * @throws TopiaException + * @throws TopiaException if any pb */ List<TopiaEntity> getAggregate() throws TopiaException; /** * Add listener for property writing. * - * @param propertyName - * @param listener + * @param propertyName name of property to listen + * @param listener the listener to register */ void addPropertyChangeListener(String propertyName, PropertyChangeListener listener); @@ -225,7 +245,7 @@ /** * Add listener for property writing. * - * @param listener + * @param listener the listener to register */ void addPropertyChangeListener(PropertyChangeListener listener); @@ -247,8 +267,8 @@ /** * Add listener for property reading. * - * @param propertyName - * @param listener + * @param propertyName the property name to listen + * @param listener the listener to register */ void addPropertyListener(String propertyName, PropertyChangeListener listener); @@ -256,7 +276,7 @@ /** * Add listener for property reading. * - * @param listener + * @param listener the listener to register */ void addPropertyListener(PropertyChangeListener listener); Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java 2010-05-10 09:40:32 UTC (rev 1946) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/TopiaEntityAbstract.java 2010-05-10 09:56:17 UTC (rev 1947) @@ -58,7 +58,7 @@ * d'entité si cela ne pose pas d'autre probleme (heritage entre ces entités). * * @author poussin <poussin@codelutin.com> - * @ version $Id$ + * @version $Id$ */ public abstract class TopiaEntityAbstract implements TopiaEntity, Serializable { Modified: trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java =================================================================== --- trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java 2010-05-10 09:40:32 UTC (rev 1946) +++ trunk/topia-persistence/src/main/java/org/nuiton/topia/persistence/package-info.java 2010-05-10 09:56:17 UTC (rev 1947) @@ -25,13 +25,14 @@ /** * This package contains interfaces and abstract classes for entities and daos. * <p /> - * For daos : {@link TopiaDAO} as interface and {@link TopiaDAImpl} as - * implementation. + * For daos : {@link org.nuiton.topia.persistence.TopiaDAO} as interface and + * {@link org.nuiton.topia.persistence.TopiaDAOImpl} as implementation. * <p /> - * For entities : {@link TopiaEntity} as interface and {@link - * TopiaEntityAbstract} as abstract class inherited by generated entities for + * For entities : {@link org.nuiton.topia.persistence.TopiaEntity} as interface + * and {@link org.nuiton.topia.persistence.TopiaEntityAbstract} + * as abstract class inherited by generated entities for * final applications. Generation is done using transformers from {@code * org.nuiton.topia.generator} package. * */ -package org.nuiton.topia.persistence; \ No newline at end of file +package org.nuiton.topia.persistence;