This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository wikitty. See http://git.nuiton.org/wikitty.git commit 866ce96cdf122bba71d3ad444f3dc309cb19bfdc Author: Eric Chatellier <chatellier@codelutin.com> Date: Thu Feb 25 16:37:05 2016 +0100 Fix javadoc 8 --- .../generator/WikittyAbstractGenerator.java | 4 +- .../wikitty/generator/WikittyDTOGenerator.java | 8 +- .../nuiton/wikitty/generator/WikittyTagValue.java | 126 +++++++++++++-------- .../wikitty/generator/WikittyTransformerUtil.java | 2 +- 4 files changed, 87 insertions(+), 53 deletions(-) diff --git a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java index cc6ab5f..d2b2f75 100644 --- a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java +++ b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyAbstractGenerator.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: generators * %% - * Copyright (C) 2009 - 2012 CodeLutin, Benjamin Poussin, Chatellier Eric + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -709,7 +709,7 @@ getPropertyChangeSupport().firePropertyChange(<%=fieldVariableName%>, oldValue, * will try to replace field name by field value for extension Person. * if this information is not available, will do unknow. * <p> - * use same syntax as {@link http://download.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax} + * use same syntax as <a href="http://download.oracle.com/javase/6/docs/api/java/util/Formatter.html#syntax">Syntax</a>. * * @param businessEntity * @param abstractClass diff --git a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java index c71ca35..cd655b0 100644 --- a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java +++ b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyDTOGenerator.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: generators * %% - * Copyright (C) 2010 - 2012 CodeLutin, Chatellier Eric + * Copyright (C) 2010 - 2016 CodeLutin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -481,7 +481,7 @@ public class WikittyDTOGenerator extends ObjectModelTransformerToJava implements * Method browse superClasses to copy methods and their bodies. The method * deal with imports, cause bodies call the Helper of the classe where * the attribute was declared. - * <p/> + * * If A inherit from B and B inherit from and A, B, C not in the same package * we B need to import CHelper and A need to import BHelper. But, since A * has C attributes too, it needs CHelper too. So when we will process B, @@ -511,9 +511,9 @@ public class WikittyDTOGenerator extends ObjectModelTransformerToJava implements * add a toString method * if a toString tagValue is attached to businessEntity, it will be used * to generate a toString as this : - * <p/> + * * given "hello {Person.name|unknow}" - * <p/> + * * will try to replace first {...} by name field value for extension Person. * if this information is not available, will do unknow. * @param businessEntity diff --git a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTagValue.java b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTagValue.java index a045fee..cd23387 100644 --- a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTagValue.java +++ b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTagValue.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: generators * %% - * Copyright (C) 2009 - 2012 CodeLutin + * Copyright (C) 2009 - 2016 CodeLutin * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as @@ -37,47 +37,58 @@ public interface WikittyTagValue { /** * version: indique la version de l'extension. - * <li> target: extension for generation + * <ul> + * <li> target: extension for generation</li> + * </ul> */ public static final String TAG_VERSION = "version"; /** * alternativeName: ce champs peut etre mis pour qu'a la generation un * des accesseur avec un autre nom soit genere. - * <li> target: field + * <ul> + * <li> target: field</li> + * </ul> */ public static final String TAG_ALTERNATIVE_NAME = "alternativeName"; /** * documentation: indique la documentation a mettre lors de la generation * peut aussi servir de documentation utilisateur a l'execution. - * <li> target: extension or field + * <ul> + * <li> target: extension or field</li> + * </ul> */ public static final String TAG_DOCUMENTATION = "documentation"; /** * toString: indique la facon de representer une extension textuellement. * exemple: - * <li> "%Person.lastName$s %Person.firstName$s: %Person.birthday$tm %Person.birthday$te,%Person.birthday$tY" - * <li> "Hello %Person.firstName|unknow$s" if firstName field doesn't exist, unknow is used - * <p> - * <li> target: extension - * <li> target: field (pour surcharger le toString par defaut de l'objet pointe pour un champs en particulier) + * <ul> + * <li> "%Person.lastName$s %Person.firstName$s: %Person.birthday$tm %Person.birthday$te,%Person.birthday$tY"</li> + * <li> "Hello %Person.firstName|unknow$s" if firstName field doesn't exist, unknow is used</li> + * </ul> + * <ul> + * <li> target: extension</li> + * <li> target: field (pour surcharger le toString par defaut de l'objet pointe pour un champs en particulier)</li> + * </ul> * - * @see WikittyUtil#format + * See: org.nuiton.wikitty.WikittyUtil#format */ public static final String TAG_TO_STRING = "toString"; /** * sortOrder: indique le tri par defaut pour cette extension. * exemple: + * <ul> * <li> "Person.lastName asc, Person.firstName, Person.birthday desc" * Liste des champs dans l'importance de l'ordre de trie. Il est possible * d'ajouter asc ou desc apres le champs pour indique qu'il faut trier en - * ordre croissant ou decroissant. - * <p> - * <li> target: extension - * @see WikittyUtil#format + * ordre croissant ou decroissant.</li> + * <li> target: extension</li> + * </ul> + * + * See org.nuiton.wikitty.WikittyUtil#format */ public static final String TAG_SORT_ORDER = "sortOrder"; @@ -92,20 +103,26 @@ public interface WikittyTagValue { * Unique: le champs doit etre une collection, ce tag indique alors s'il vaut * true que la collection ne peut pas contenir de doublon (Set) si unique * est false alors la collection peut contenir des doublons (List). - * <li> target: collection field + * <ul> + * <li> target: collection field</li> + * </ul> */ public static final String TAG_UNIQUE = "unique"; /** * notNull: indique que le champs ne peut pas etre null, il doit forcement * avoir une valeur lors de la sauvegarde. - * <li> target: field + * <ul> + * <li> target: field</li> + * </ul> */ public static final String TAG_NOT_NULL = "notNull"; /** * default: indique la valeur par defaut si le champs est null. - * <li> target: field + * <ul> + * <li> target: field</li> + * </ul> * @since 2.9 */ public static final String TAG_DEFAULT_VALUE = "default"; @@ -114,12 +131,12 @@ public interface WikittyTagValue { * pattern: pour une String indique que le champs doit respecter un certain * pattern, sinon la sauvegarde echoue. Pour un numeric ou une date pattern * peut-etre utilise comme masque de saisie. Exemple: - * <li>"A.*" le champs doit commencer par 'A' + * <ul> + * <li>"A.*" le champs doit commencer par 'A'</li> * <li>"[0-9]+\.[0-9][0-9]" le nombre doit avoir deux chiffres apres la virgule - * <p> - * Lors de l'affichage si un pattern est defini, il peut etre utilise - * + * Lors de l'affichage si un pattern est defini, il peut etre utilise</li> * <li> target: numeric or String field + * </ul> */ public static final String TAG_PATTERN = "pattern"; @@ -127,7 +144,9 @@ public interface WikittyTagValue { * indexed: indique qu'un champs ne doit pas etre indexe, par defaut si ce * tag value n'existe pas il vaut true. Il faut donc le positionner * explicitement a false si on ne veut pas indexer un champs - * <li> target: field + * <ul> + * <li> target: field</li> + * </ul> */ public static final String TAG_INDEXED = "indexed"; @@ -137,14 +156,14 @@ public interface WikittyTagValue { * sera pas indexe. Si le cryptage n'est pas possible, la sauvegarde ne se * fera pas (Exeption). * exemple: + * <ul> * <li>crypt=Blowfish:password * * TODO: si le mot de passe n'est pas specifie, utiliser le mot de passe - * du fichier de configuration - * <p> - * - * <li> target: field - * @see {@link http://docs.oracle.com/javase/6/docs/technotes/guides/security/SunProviders.html#SunJCEProvider} + * du fichier de configuration</li> + * <li> target: field</li> + * </ul> + * @see "http://docs.oracle.com/javase/6/docs/technotes/guides/security/SunProviders...." */ public static final String TAG_CRYPT = "crypt"; @@ -152,44 +171,55 @@ public interface WikittyTagValue { * preload: indique les champs de type Wikitty qui doivent etre preloade * lors du chargement de cette extension. * exemple: - * <li> preload="Company.employee,Employee.person;Company.address" - * <p> - * <li> target: extension + * <ul> + * <li> preload="Company.employee,Employee.person;Company.address"</li> + * <li> target: extension</li> + * </ul> */ public static final String TAG_PRELOAD = "preload"; /** * subtype: indique que le champs a un sous type. Ce sous type est différent * pour chaque type possible d'un champs - * <li> Boolean: aucun pour l'instant - * <li> Binary: aucun pour l'instant + * <ul> + * <li> Boolean: aucun pour l'instant</li> + * <li> Binary: aucun pour l'instant</li> * <li> Date + * <ul> * <li> 'date' (defaut) indique que seule la date est pertinante</li> * <li> 'month' indique que seule le mois et l'annee sont pertinants</li> * <li> 'time' indique que seule l'heure est pertinante</li> * <li> 'datetime' indique que la date et l'heure sont pertinantes</li> + * </ul> + * </li> * <li> Numeric + * <ul> * <li> 'real' (defaut) indique que le nombre est de type reel</li> * <li> 'integer' indique que le nombre est de type entier</li> * <li> 'currency' indique que le nombre est de type reel et represente une somme d'argent</li> * <li> 'percent' indique que le nombre est un pourcentage</li> + * </ul> + * </li> * <li> String + * <ul> * <li> 'char' indique que la chaine ne peut qu'un caractere</li> * <li> 'monoline' (defaut) indique que la chaine ne peut contenir qu'une ligne</li> * <li> 'multiline' indique que la chaine peut-etre multiligne</li> * <li> '[mime type]' indique que la chaine represente le type mime - * precisse. exemple: 'text/plain' ou 'text/javascript' ou 'text/html' - * <li> Wikitty: aucun pour l'instant - * - * <p> - * <li> target: field + * precisse. exemple: 'text/plain' ou 'text/javascript' ou 'text/html'</li> + * </ul> + * </li> + * <li> Wikitty: aucun pour l'instant</li> + * <li> target: field</li> + * </ul> */ public static final String TAG_SUBTYPE = "subtype"; /** * allowed: indique que le champs devra prendre sa valeur dans une des valeurs * de ce tag. Les differentes valeurs sont separees par une virgule. - * <li> Boolean ne s'applique pas + * <ul> + * <li> Boolean ne s'applique pas</li> * <li> Binary: l'utilisateur ne pourra importer des binaires que du type * mime indique (s'additionne avec les resultats de allowedQuery). * Ne s'applique que si le champs binaire doit contenir un fichier. @@ -198,8 +228,8 @@ public interface WikittyTagValue { * champs texte (par exemple 'mimetype') qui contiendra la valeur du fichier * mis dans le champs binaire et mettre sur ce champs le meme tag value * allowed que sur le champs binaire</li> - * <li> Date ne s'applique pas (voir {@link #TAG_MIN} {@link #TAG_MAX}) - * <li> Numeric ne s'applique pas (voir {@link #TAG_MIN} {@link #TAG_MAX}) + * <li> Date ne s'applique pas (voir {@link #TAG_MIN} {@link #TAG_MAX})</li> + * <li> Numeric ne s'applique pas (voir {@link #TAG_MIN} {@link #TAG_MAX})</li> * <li> String: l'utilisateur ne pourra mettre comme valeur que des valeurs * presentes dans allowed (s'additionne avec les resultats de allowedQuery).</li> * <li> Wikitty: l'utilisateur devra choisir l'objet dans la liste des objets @@ -207,10 +237,13 @@ public interface WikittyTagValue { * allowedQuery prend le dessus sur allowed. *<p> * exemple: - * <li> String companyType allowed="SA,SARL,SAS" allowedQuery="SELECT Company.companyType WHERE extension=Company" - * <li> Wikitty target allowed="Person,Employee,Company" - * <p> - * <li> target: field + * <ul> + * <li> String companyType allowed="SA,SARL,SAS" allowedQuery="SELECT Company.companyType WHERE extension=Company"</li> + * <li> Wikitty target allowed="Person,Employee,Company"</li> + * </ul> + * </li> + * <li> target: field</li> + * </ul> */ public static final String TAG_ALLOWED = "allowed"; /** @@ -227,8 +260,9 @@ public interface WikittyTagValue { * nouvelle valeur. Les valeurs sont separees par des virgules * <p> * exemple: - * <li>String type choice="SA,SAS,SARL,SARL SCOOP,EURL" - * + * <ul> + * <li>String type choice="SA,SAS,SARL,SARL SCOOP,EURL"</li> + * </ul> */ public static final String TAG_CHOICE = "choice"; /** diff --git a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTransformerUtil.java b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTransformerUtil.java index 296cd6d..e84e2f7 100644 --- a/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTransformerUtil.java +++ b/wikitty-generators/src/main/java/org/nuiton/wikitty/generator/WikittyTransformerUtil.java @@ -2,7 +2,7 @@ * #%L * Wikitty :: generators * %% - * Copyright (C) 2009 - 2012 CodeLutin, Benjamin Poussin, Chatellier Eric + * Copyright (C) 2009 - 2016 CodeLutin, Benjamin Poussin, Chatellier Eric * %% * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as -- To stop receiving notification emails like this one, please contact nuiton.org SCM administrator <admin+scm@nuiton.org>.