ofbiz-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jacques Le Roux <jacques.le.r...@les7arts.com>
Subject Re: svn commit: r1804635 - in /ofbiz/ofbiz-framework/trunk: applications/order/src/main/java/org/apache/ofbiz/order/order/ framework/base/src/main/java/org/apache/ofbiz/base/container/ framework/start/src/main/java/org/apache/ofbiz/base/start/
Date Thu, 10 Aug 2017 07:00:32 GMT
Weirdly it does not complain about @return. Go figure!

But I'll apply the same!

Jacques


Le 10/08/2017 à 08:31, jleroux@apache.org a écrit :
> Author: jleroux
> Date: Thu Aug 10 06:31:38 2017
> New Revision: 1804635
>
> URL: http://svn.apache.org/viewvc?rev=1804635&view=rev
> Log:
> No functional trivial changes
>
> When reviewing code, Eclipse complains: "Javadoc: Invalid param tag name"
> when a param tag name "contains" a colon at end
>
> This removes all cases found in trunk. Another way could be to add a space
> between the tag and the colon. But that's not how it's recommended to write
>
> http://www.oracle.com/technetwork/articles/java/index-137868.html
>
> Modified:
>      ofbiz/ofbiz-framework/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java
>      ofbiz/ofbiz-framework/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ComponentContainer.java
>      ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/AdminClient.java
>      ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
>      ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupControlPanel.java
>
> Modified: ofbiz/ofbiz-framework/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java
> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java?rev=1804635&r1=1804634&r2=1804635&view=diff
> ==============================================================================
> --- ofbiz/ofbiz-framework/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java
(original)
> +++ ofbiz/ofbiz-framework/trunk/applications/order/src/main/java/org/apache/ofbiz/order/order/OrderServices.java
Thu Aug 10 06:31:38 2017
> @@ -5768,7 +5768,7 @@ public class OrderServices {
>       /**
>        * Remove an OrderItemShipGroup record
>        * @param ctx
> -     * @param context: a map containing in paramaters
> +     * @param context a map containing in paramaters
>        * @return result: a map containing out parameters
>        * @throws GenericEntityException
>        */
>
> Modified: ofbiz/ofbiz-framework/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ComponentContainer.java
> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ComponentContainer.java?rev=1804635&r1=1804634&r2=1804635&view=diff
> ==============================================================================
> --- ofbiz/ofbiz-framework/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ComponentContainer.java
(original)
> +++ ofbiz/ofbiz-framework/trunk/framework/base/src/main/java/org/apache/ofbiz/base/container/ComponentContainer.java
Thu Aug 10 06:31:38 2017
> @@ -85,7 +85,7 @@ public class ComponentContainer implemen
>        * Iterate over all the components and load their classpath URLs into the classloader
>        * and set the classloader as the context classloader
>        *
> -     * @param componentsClassPath: a list of classpaths for all components
> +     * @param componentsClassPath a list of classpaths for all components
>        * @throws ContainerException
>        */
>       private void loadClassPathForAllComponents(List<Classpath> componentsClassPath)
throws ContainerException {
> @@ -107,8 +107,8 @@ public class ComponentContainer implemen
>        * Checks if <code>ComponentDef.type</code> is a directory or a single
component.
>        * If it is a directory, load the directory, otherwise load a single component
>        *
> -     * @param parentPath: the parent path of what is being loaded
> -     * @param def: the component or directory loader definition
> +     * @param parentPath the parent path of what is being loaded
> +     * @param def the component or directory loader definition
>        * @throws IOException
>        */
>       private void loadComponentFromConfig(String parentPath, ComponentLoaderConfig.ComponentDef
def) throws IOException {
> @@ -128,7 +128,7 @@ public class ComponentContainer implemen
>        * Checks to see if the directory contains a load file (component-load.xml) and
>        * then delegates loading to the appropriate method
>        *
> -     * @param directoryName: the name of component directory to load
> +     * @param directoryName the name of component directory to load
>        * @throws IOException
>        */
>       private void loadComponentDirectory(String directoryName) throws IOException {
> @@ -153,8 +153,8 @@ public class ComponentContainer implemen
>        * load file (component-load.xml) and they are sorted in order from top to bottom
>        * in the load file
>        *
> -     * @param directoryPath: the absolute path of the directory
> -     * @param componentLoadFile: the name of the load file (i.e. component-load.xml)
> +     * @param directoryPath the absolute path of the directory
> +     * @param componentLoadFile the name of the load file (i.e. component-load.xml)
>        * @throws IOException
>        */
>       private void loadComponentsInDirectoryUsingLoadFile(File directoryPath, File componentLoadFile)
throws IOException {
> @@ -179,7 +179,7 @@ public class ComponentContainer implemen
>        * a load-components.xml file. The components are sorted alphabetically
>        * for loading purposes
>        *
> -     * @param directoryPath: the absolute path of the directory
> +     * @param directoryPath the absolute path of the directory
>        * @throws IOException
>        */
>       private void loadComponentsInDirectory(File directoryPath) throws IOException {
> @@ -203,8 +203,8 @@ public class ComponentContainer implemen
>       /**
>        * Fetch the <code>ComponentConfig</code> for a certain component
>        *
> -     * @param name: component name
> -     * @param location: directory location of the component
> +     * @param name component name
> +     * @param location directory location of the component
>        * @return The component configuration
>        */
>       private ComponentConfig retrieveComponentConfig(String name, String location) {
> @@ -224,7 +224,7 @@ public class ComponentContainer implemen
>        * Load a single component by adding all its classpath entries to
>        * the list of classpaths to be loaded
>        *
> -     * @param config: the component configuration
> +     * @param config the component configuration
>        * @throws IOException
>        */
>       private void loadComponent(ComponentConfig config) throws IOException {
> @@ -241,7 +241,7 @@ public class ComponentContainer implemen
>        * Construct a <code>Classpath</code> object for a certain component
based
>        * on its configuration defined in <code>ComponentConfig</code>
>        *
> -     * @param config: the component configuration
> +     * @param config the component configuration
>        * @return the constructed classpath
>        * @throws IOException
>        */
>
> Modified: ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/AdminClient.java
> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/AdminClient.java?rev=1804635&r1=1804634&r2=1804635&view=diff
> ==============================================================================
> --- ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/AdminClient.java
(original)
> +++ ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/AdminClient.java
Thu Aug 10 06:31:38 2017
> @@ -38,7 +38,7 @@ class AdminClient {
>        * Send a command through network to OFBiz server
>        * to show its status (running, stopping, ...)
>        *
> -     * @param config: OFBiz configuration
> +     * @param config OFBiz configuration
>        * @return status: OFBiz server status
>        */
>       static String requestStatus(Config config) {
> @@ -57,7 +57,7 @@ class AdminClient {
>        * Send a command through network to OFBiz server
>        * to shut itself down.
>        *
> -     * @param config: OFBiz configuration
> +     * @param config OFBiz configuration
>        * @return shutdownMessage: message from server
>        *   on receiving shutdown request
>        */
>
> Modified: ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java?rev=1804635&r1=1804634&r2=1804635&view=diff
> ==============================================================================
> --- ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
(original)
> +++ ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/Start.java
Thu Aug 10 06:31:38 2017
> @@ -52,7 +52,7 @@ public final class Start {
>        * main is the entry point to execute high level OFBiz commands
>        * such as starting, stopping or checking the status of the server.
>        *
> -     * @param args: The commands for OFBiz
> +     * @param args The commands for OFBiz
>        */
>       public static void main(String[] args) {
>           List<StartupCommand> ofbizCommands = null;
>
> Modified: ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupControlPanel.java
> URL: http://svn.apache.org/viewvc/ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupControlPanel.java?rev=1804635&r1=1804634&r2=1804635&view=diff
> ==============================================================================
> --- ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupControlPanel.java
(original)
> +++ ofbiz/ofbiz-framework/trunk/framework/start/src/main/java/org/apache/ofbiz/base/start/StartupControlPanel.java
Thu Aug 10 06:31:38 2017
> @@ -42,7 +42,7 @@ final class StartupControlPanel {
>        * - setting high level JVM and OFBiz system properties
>        * - creating a Config object holding startup configuration parameters
>        *
> -     * @param ofbizCommands: commands passed by the user to OFBiz on start
> +     * @param ofbizCommands commands passed by the user to OFBiz on start
>        * @return config: OFBiz configuration
>        */
>       static Config init(List<StartupCommand> ofbizCommands) {
> @@ -76,7 +76,7 @@ final class StartupControlPanel {
>   
>       /**
>        * Print OFBiz startup message only if the OFBiz server is not scheduled for shutdown.
> -     * @param config: contains parameters for system startup
> +     * @param config contains parameters for system startup
>        */
>       private static void printStartupMessage(Config config) {
>           if (!config.shutdownAfterLoad) {
> @@ -114,7 +114,7 @@ final class StartupControlPanel {
>        * - Providing an exit code that is not 0 to signal to the build system
>        *   or user of failure to execute.
>        *
> -     * @param e: The startup exception that cannot / should not be handled
> +     * @param e The startup exception that cannot / should not be handled
>        *   except by terminating the system
>        */
>       static void fullyTerminateSystem(StartupException e) {
>
>
>


Mime
View raw message