Author: painter Date: Thu Jan 10 17:54:13 2019 New Revision: 1850967 URL: http://svn.apache.org/viewvc?rev=1850967&view=rev Log: JavaDoc cleanup, mvn javadoc:javadoc runs ok now
Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/AbstractConfigurationProvider.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/ClassHelper.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/PackageResources.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Loglevel.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Output.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfiguration.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/CustomProjectPaths.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/DefaultTorqueGeneratorPaths.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/SchemaType.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/Outlet.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/OutletImpl.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/processor/string/ConstantNameCreator.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/Namespace.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/ModelPropertyPointer.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/PostprocessorDefinition.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElementNodePointer.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceProvider.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/JdbcMetadataSourceProvider.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/AttributeTransformer.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/SourceElementToModelTransformer.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/model/NoSuchPropertyException.java db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/variable/VariableStore.java Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/AbstractConfigurationProvider.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/AbstractConfigurationProvider.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/AbstractConfigurationProvider.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/AbstractConfigurationProvider.java Thu Jan 10 17:54:13 2019 @@ -55,8 +55,8 @@ implements ConfigurationProvider this.configurationPaths = configurationPaths; } - /** - * @see ConfigurationProvider#getControlConfigurationInputStream() + /* (non-Javadoc) + * @see org.apache.torque.generator.configuration.ConfigurationProvider#getControlConfigurationInputStream() */ @Override public InputStream getControlConfigurationInputStream() @@ -68,8 +68,8 @@ implements ConfigurationProvider "control file"); } - /** - * @see ConfigurationProvider#getTemplateInputStream() + /* (non-Javadoc) + * @see org.apache.torque.generator.configuration.ConfigurationProvider#getTemplateInputStream(java.lang.String) */ @Override public InputStream getTemplateInputStream(final String name) @@ -81,8 +81,8 @@ implements ConfigurationProvider "template"); } - /** - * @see ConfigurationProvider#getOutletConfigurationInputStream(String) + /* (non-Javadoc) + * @see org.apache.torque.generator.configuration.ConfigurationProvider#getOutletConfigurationInputStream(java.lang.String) */ @Override public InputStream getOutletConfigurationInputStream(final String name) @@ -94,8 +94,8 @@ implements ConfigurationProvider "outlet configuration"); } - /** - * @see ConfigurationProvider#getResourceInputStream(String) + /* (non-Javadoc) + * @see org.apache.torque.generator.configuration.ConfigurationProvider#getResourceInputStream(java.lang.String) */ @Override public InputStream getResourceInputStream(final String name) @@ -107,8 +107,8 @@ implements ConfigurationProvider "resource"); } - /** - * @see ConfigurationProvider#getOptionsInputStream(String) + /* (non-Javadoc) + * @see org.apache.torque.generator.configuration.ConfigurationProvider#getOptionsInputStream(java.lang.String) */ @Override public InputStream getOptionsInputStream(final String name) @@ -120,6 +120,13 @@ implements ConfigurationProvider "option"); } + /** + * @param name input stream name + * @param directory location + * @param fileDescription describes the file + * @return an InputStream + * @throws ConfigurationException if unable to process + */ protected abstract InputStream getInputStream( String name, String directory, Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/ClassHelper.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/ClassHelper.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/ClassHelper.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/ClassHelper.java Thu Jan 10 17:54:13 2019 @@ -34,7 +34,7 @@ public final class ClassHelper } /** - * Creates an instance of ca class and checks whether it can be casted + * Creates an instance of a class and checks whether it can be casted * to another class * * @param className the fully qualified name of the class to instantiate. @@ -42,6 +42,7 @@ public final class ClassHelper * must be an instance of, or null to disable the check. * @param unitDescriptor The description of the generation unit, not null. * + * @return the instance of the class * @throws ConfigurationException if the class cannot be instantiated * or it is not an instance of <code>isInstanceOf</code> */ Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/PackageResources.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/PackageResources.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/PackageResources.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/PackageResources.java Thu Jan 10 17:54:13 2019 @@ -163,6 +163,7 @@ public class PackageResources /** * Returns whether the queried package exists in the class path. + * @return true if package does not exist */ public boolean isEmpty() { Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Loglevel.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Loglevel.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Loglevel.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Loglevel.java Thu Jan 10 17:54:13 2019 @@ -121,8 +121,7 @@ public enum Loglevel /** * Sets the logging adapter. * - * @return the logging adapter, not null. - * + * @param loggingAdapter the logging adapter * @throws NullPointerException if loggingAdapter is null. */ public static void setLoggingAdapter(LoggingAdapter loggingAdapter) Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Output.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Output.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Output.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/controller/Output.java Thu Jan 10 17:54:13 2019 @@ -356,13 +356,19 @@ public class Output /** * Returns the line break character(s) for this Output. + * + * <p> * If the line break was already determined, the already determined * line break character(s) are returned, and content is ignored. + * + * <p> * If the line break character was not already determined, - * the occurence of the different line break characters is counted + * the occurrence of the different line break characters is counted * and the largest is returned ("\r\n" for equal count) - * If one of them is > 0, the result is cached and stored; - * if all occurences are 0, the result is not cached and will be determined + * + * <p> + * If one of them is > 0, the result is cached and stored; + * if all occurrences are 0, the result is not cached and will be determined * anew if the method is called another time for the same output. * * @param content the already produced content. Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfiguration.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfiguration.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfiguration.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/outlet/OutletConfiguration.java Thu Jan 10 17:54:13 2019 @@ -96,9 +96,10 @@ public class OutletConfiguration } /** - * Resolves the isolated mergepoint mappings and adds them to + * Resolves the isolated merge point mappings and adds them to * the relevant outlets. - * @throws ConfigurationException + * + * @throws ConfigurationException if configuration not found */ public void resolveMergepointMappings() throws ConfigurationException { Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/CustomProjectPaths.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/CustomProjectPaths.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/CustomProjectPaths.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/CustomProjectPaths.java Thu Jan 10 17:54:13 2019 @@ -323,7 +323,7 @@ public class CustomProjectPaths implemen * It is checked whether all necessary informations are set. * If not, an IllegalStateException is thrown. * - * @throws true if the current settings are valid, false otherwise. + * @throws IllegalStateException if the current settings are valid, false otherwise. */ public void checkInit() { Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/DefaultTorqueGeneratorPaths.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/DefaultTorqueGeneratorPaths.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/DefaultTorqueGeneratorPaths.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/configuration/paths/DefaultTorqueGeneratorPaths.java Thu Jan 10 17:54:13 2019 @@ -21,13 +21,18 @@ package org.apache.torque.generator.conf /** * The default organization of the torque-generator directory. - * This is:<br/> - * - torque-generator root<br/> - * - - conf<br/> - * - - - control.xml<br/> - * - - outlets<br/> - * - - templates<br/> - * - - resources<br/> + * + * <p> + * This is: + * <pre> + * - torque-generator root + * - - conf + * - - - control.xml + * - - outlets + * - - templates + * - - resources + * </pre> + * */ public class DefaultTorqueGeneratorPaths implements TorqueGeneratorPaths { Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/Controller.java Thu Jan 10 17:54:13 2019 @@ -126,7 +126,6 @@ public class Controller * processing. * @throws GeneratorException if a OutletException occurs during * processing. - * @throws IOException if a IOException occurs during processing. */ public void run(final List<UnitDescriptor> unitDescriptors) throws GeneratorException @@ -618,13 +617,15 @@ public class Controller /** * Applies all transformer definitions to the current source. * - * @param rootElement the root element of the source to transform, + * @param sourceRoot the root element of the source to transform, * not null. * @param transformerDefinitions the transformer definitions to apply, * not null. * @param controllerState the current controller state, not null. * * @return the transformed root element, not null. + * @throws SourceTransformerException if error in transform + * @throws SourceException if source not found */ public Object transformSource( final Object sourceRoot, Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/control/ControllerState.java Thu Jan 10 17:54:13 2019 @@ -219,7 +219,7 @@ public class ControllerState /** * Sets the current source model object. * - * @param sourceElement the new current source model object, or null + * @param model the new current source model object, or null * to remove the current source model object. * @param newPathToModel the path from root * to the new model, or null to leave the path unchanged. @@ -396,8 +396,11 @@ public class ControllerState /** * Convenience method to return the value of an option as boolean. * The option is evaluated in the current outlet's context, see - * getOption(String). <br/> - * Uses Boolean.paseBoolean() for String->Boolean conversion. + * getOption(String). + * + * <p> + * Uses Boolean.paseBoolean() for String -> Boolean conversion. + * * @param name the name of the option, can contain a namespace. * * @return The value of the option as boolean, or false if no option @@ -416,8 +419,10 @@ public class ControllerState /** * Convenience method to return the value of an option as boolean. * The option is evaluated in the current outlet's context, see - * getOption(String). <br/> - * Uses Boolean.paseBoolean() for String->Boolean conversion. + * getOption(String). + * + * <p> + * Uses Boolean.paseBoolean() for String -> Boolean conversion. * * @param optionName the object containing the name of the option, * which can contain a namespace. @@ -425,7 +430,7 @@ public class ControllerState * @return The value of the option as boolean, or false if no option * with that name is visible from the given namespace. * - * @throws NullPointerExeption if optionName is null. + * @throws NullPointerException if optionName is null. */ public boolean getBooleanOption(final OptionName optionName) { @@ -435,7 +440,7 @@ public class ControllerState /** * Convenience method to return the value of an option as String. * The option is evaluated in the current outlet's context, see - * getOption(String). <br/> + * getOption(String). * * @param name the name of the option, can contain a namespace. * @@ -455,7 +460,7 @@ public class ControllerState /** * Convenience method to return the value of an option as String. * The option is evaluated in the current outlet's context, see - * getOption(String). <br/> + * getOption(String). * * @param optionName the object containing the name of the option, * which can contain a namespace. @@ -463,7 +468,7 @@ public class ControllerState * @return The value of the option as String, or null if no option * with that name is visible from the given namespace, * - * @throws NullPointerExeption if optionName is null. + * @throws NullPointerException if optionName is null. */ public String getStringOption(final OptionName optionName) { @@ -494,7 +499,7 @@ public class ControllerState /** * Converts a name to a QualifiedName, using the outlet namespace as - * default namespace is fone is given. + * default namespace is none is given. * * @param name the name to convert to a qualifiedName, not null. * @return the corresponding qualifiedName. Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/SchemaType.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/SchemaType.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/SchemaType.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/jdbc/SchemaType.java Thu Jan 10 17:54:13 2019 @@ -24,7 +24,7 @@ import java.sql.Types; /** * Enum for known SQL types. * - * @author <a href="mailto:mpoes...@marmot.at>Martin Poeschl</a> + * @author <a href="mailto:mpoes...@marmot.at">Martin Poeschl</a> * @version $Id$ */ public enum SchemaType Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/Outlet.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/Outlet.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/Outlet.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/Outlet.java Thu Jan 10 17:54:13 2019 @@ -119,7 +119,7 @@ public interface Outlet * corresponds to the set class name * and throws an exception if the names do not match. * - * @param inputName the name of the root element of the source, + * @param inputClass the name of the root element of the source, * or null to accept any input name. */ void setInputClass(String inputClass); Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/OutletImpl.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/OutletImpl.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/OutletImpl.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/outlet/OutletImpl.java Thu Jan 10 17:54:13 2019 @@ -37,7 +37,7 @@ import org.apache.torque.generator.varia import org.apache.torque.generator.variable.VariableStore; /** - * Implementation of the features in the <code>Outlet<code> interface + * Implementation of the features in the <code>Outlet</code> interface * which do not depend on type of Outlet. */ public abstract class OutletImpl implements Outlet @@ -48,7 +48,7 @@ public abstract class OutletImpl impleme private static Log log = LogFactory.getLog(OutletImpl.class); /** - * The mergepoint mappings configured for this outlet. + * The merge point mappings configured for this outlet. */ private final Map<String, MergepointMapping> mergepointMappings = new HashMap<>(); Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/processor/string/ConstantNameCreator.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/processor/string/ConstantNameCreator.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/processor/string/ConstantNameCreator.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/processor/string/ConstantNameCreator.java Thu Jan 10 17:54:13 2019 @@ -82,7 +82,8 @@ public class ConstantNameCreator extends * If the string starts is empty or start with a number, the character <code>toReplaceWith</code> * is prefixed to the constant name. * Finally, the new String is returned. - * <br/> + * + * <p> * Example: "prOceSS-*+ing~#._Test" is converted to "PR_OCE_SS_ING_TEST" * * @param toProcess the String in which replacement should occur, not null. Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/Namespace.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/Namespace.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/Namespace.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/Namespace.java Thu Jan 10 17:54:13 2019 @@ -217,8 +217,8 @@ public final class Namespace * Note that for being a child, all the parts of the namespace separated * by a dot must be equal. * For example, "org.apache.torque" is visible from the namespace - * quot;org.apache.torque.generator", but not from - * "org.apache". + * "org.apache.torque.generator", but not from + * "org.apache" * * @param otherNamespace the namespace against this namespace * should be checked, not null. Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/qname/QualifiedName.java Thu Jan 10 17:54:13 2019 @@ -25,7 +25,7 @@ import org.apache.commons.lang.StringUti /** * This class contains a name which has a namespace. The namespace defines the * scope where the name is valid, and is made up of hierarchical bits - * separated by a dot (<code>SEPARATOR<code>). + * separated by a dot (<code>SEPARATOR</code>). * A qualified name is in the scope of its own namespace and all children * namespaces of its own namespace (i.e. the namespaces "deeper down" * the hierarchy). For example, the namespace org.apache.torque @@ -35,7 +35,7 @@ import org.apache.commons.lang.StringUti * the name is valid in all namespaces. * * The namespace and the name are also separated by a dot - * (<code>SEPARATOR<code>). + * (<code>SEPARATOR</code>). * * Instances of this class are immutable. To prevent mutable subclasses, * this class is final. @@ -197,8 +197,8 @@ public final class QualifiedName * Note that for being a child, all the parts of the namespace separated * by a dot must be equal. * For example, "org.apache.torque:name" is visible from the - * namespaces quot;org.apache.torque.generator" and - * quot;org.apache.torque", but not from "org.apache". + * namespaces "org.apache.torque.generator" and + * "org.apache.torque", but not from "org.apache" * * @param otherNamespace the namespace against this QualifiedName * should be checked, not null. Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/ModelPropertyPointer.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/ModelPropertyPointer.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/ModelPropertyPointer.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/ModelPropertyPointer.java Thu Jan 10 17:54:13 2019 @@ -80,6 +80,7 @@ public class ModelPropertyPointer extend * Create a new BeanPropertyPointer. * @param parent parent pointer * @param beanInfo describes the target property/ies. + * @param valueClass the class of the base object */ public ModelPropertyPointer( final NodePointer parent, Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/PostprocessorDefinition.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/PostprocessorDefinition.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/PostprocessorDefinition.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/PostprocessorDefinition.java Thu Jan 10 17:54:13 2019 @@ -39,7 +39,7 @@ public final class PostprocessorDefiniti /** * Constructor. * - * @param sourceTransformer the postprocessor instance, not null. + * @param postprocessor instance, not null. */ public PostprocessorDefinition( final StringProcessor postprocessor) Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElementNodePointer.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElementNodePointer.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElementNodePointer.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceElementNodePointer.java Thu Jan 10 17:54:13 2019 @@ -160,7 +160,7 @@ public class SourceElementNodePointer ex /** * Test a Node. - * @param node to test + * @param sourceElement node to test * @param test to execute * @return true if node passes test */ Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceProvider.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceProvider.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceProvider.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/SourceProvider.java Thu Jan 10 17:54:13 2019 @@ -131,6 +131,7 @@ public abstract class SourceProvider imp * {@link #init(ConfigurationHandlers, ControllerState)} * method of the new source provider must be called before it can be used. * + * @return the SourceProvider * @throws ConfigurationException if the new SourceProvider cannot * be initialized. */ Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/JdbcMetadataSourceProvider.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/JdbcMetadataSourceProvider.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/JdbcMetadataSourceProvider.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/jdbc/JdbcMetadataSourceProvider.java Thu Jan 10 17:54:13 2019 @@ -92,10 +92,10 @@ public class JdbcMetadataSourceProvider } - /** + /* (non-Javadoc) + * @see org.apache.torque.generator.source.SourceProvider#initInternal(org.apache.torque.generator.configuration.ConfigurationHandlers, org.apache.torque.generator.control.ControllerState) + * * Generates an XML database schema from JDBC metadata. - * - * @throws Exception a generic exception. */ @Override public void initInternal( Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/AttributeTransformer.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/AttributeTransformer.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/AttributeTransformer.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/AttributeTransformer.java Thu Jan 10 17:54:13 2019 @@ -33,9 +33,11 @@ import org.apache.torque.generator.sourc /** * Adds or replaces attributes in a SourceElement according to a definition * file. An example for a line in the definition file would be: - * <br/><br/> + * + * <p> * ${attribute(override):newAttribute}=prefix${attribute:oldAttribute}${option:suffix} - * <br/><br/> + * + * <p> * This would add the attribute newAttribute to the current sourceElement, * and its content would be (in java notation) * "prefix" @@ -43,7 +45,8 @@ import org.apache.torque.generator.sourc * ? "" * : currentElement.getAttribute("oldAttribute")) * + options.getOption("suffix") - * <br/><br/> + * + * <p> * On the left hand side, one can use attribute(override) (which replaces * the attribute if its already there) and attribute(noOverride) which * preserves the attribute if its already there. Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/SourceElementToModelTransformer.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/SourceElementToModelTransformer.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/SourceElementToModelTransformer.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/SourceElementToModelTransformer.java Thu Jan 10 17:54:13 2019 @@ -121,14 +121,15 @@ public class SourceElementToModelTransfo } /** + * @see org.apache.torque.generator.source.transform.SourceTransformer#transform(java.lang.Object, org.apache.torque.generator.control.ControllerState) + * * Transforms the source graph into the model. This is done by recursively * walking through the source graph and setting the fields corresponding - * to the names of the attributes resp. child elements. - * + * to the names of the attributes resp. child elements. + * * @param modelRoot the root object to fill, not null. - * @param rootSourceElement the root source element to traverse, not null. - * @param unitConfiguration the unit configuration, not null. - * + * @param controllerState the controller state object + * * @throws SourceTransformerException if filling the source graph fails, * e.g. if an attribute name or element name has no corresponding * field in a model element. @@ -297,8 +298,8 @@ public class SourceElementToModelTransfo * Creates an instance of a class. * * @param className the fully qualified name of the class to instantiate. - * @param unitDescriptor The description of the generation unit, not null. - * + * @param unitConfiguration The configuration of the generation unit, not null. + * @return the instance of the class * @throws SourceTransformerException if the class cannot be instantiated. */ protected static Object getInstance( Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/model/NoSuchPropertyException.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/model/NoSuchPropertyException.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/model/NoSuchPropertyException.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/source/transform/model/NoSuchPropertyException.java Thu Jan 10 17:54:13 2019 @@ -39,6 +39,8 @@ public class NoSuchPropertyException ext * @param target the object on which the property was unsuccessfully * accessed. * @param name the name of the property which was unsuccessfully accessed. + * @param prefixList list of prefixes + * @param suffixList list of suffixes */ public NoSuchPropertyException( Object target, Modified: db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/variable/VariableStore.java URL: http://svn.apache.org/viewvc/db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/variable/VariableStore.java?rev=1850967&r1=1850966&r2=1850967&view=diff ============================================================================== --- db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/variable/VariableStore.java (original) +++ db/torque/torque4/trunk/torque-generator/src/main/java/org/apache/torque/generator/variable/VariableStore.java Thu Jan 10 17:54:13 2019 @@ -182,7 +182,7 @@ public class VariableStore * <p> * Note: The current store content is rebuilt each time this method is * called. For this reason, <code>store.getInHierarchy(qualifiedName)</code> - * is much faster than <code>store.getContent().get(qualifiedName)<code>. + * is much faster than <code>store.getContent().get(qualifiedName)</code>. * * @return a map with the variables contained ins this store, never null. */ --------------------------------------------------------------------- To unsubscribe, e-mail: torque-dev-unsubscr...@db.apache.org For additional commands, e-mail: torque-dev-h...@db.apache.org