incubator-nmaven-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sisb...@apache.org
Subject svn commit: r531670 - in /incubator/nmaven/branches/SI_XPT/components: dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/ dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/ dotnet-executable/src/main/java/org/...
Date Tue, 24 Apr 2007 01:05:33 GMT
Author: sisbell
Date: Mon Apr 23 18:05:32 2007
New Revision: 531670

URL: http://svn.apache.org/viewvc?view=rev&rev=531670
Log:
Javadoc updates.

Modified:
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/CapabilityMatcher.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/CompilerConfig.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/KeyInfo.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/BaseCompiler.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/CSharpCompilerForProfile.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/DotGNUCompiler.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/RubyCompiler.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CapabilityMatcherImpl.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerContextImpl.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerPluginsRepository.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultNetExecutable.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultRepositoryNetExecutable.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutableContextImpl.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutablePluginsRepository.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/NetExecutableFactoryImpl.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/RepositoryExecutableContextImpl.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ThreadedNetExecutable.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/AbstractMojo.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/DotNetMojo.java
    incubator/nmaven/branches/SI_XPT/components/dotnet-vendor/src/test/java/org/apache/maven/dotnet/vendor/impl/MatchPolicyFactoryTest.java

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/CapabilityMatcher.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/CapabilityMatcher.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/CapabilityMatcher.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/CapabilityMatcher.java
Mon Apr 23 18:05:32 2007
@@ -18,14 +18,11 @@
  */
 package org.apache.maven.dotnet.executable;
 
-import org.apache.maven.dotnet.InitializationException;
 import org.apache.maven.dotnet.PlatformUnsupportedException;
 import org.apache.maven.dotnet.executable.compiler.CompilerRequirement;
 import org.apache.maven.dotnet.executable.compiler.CompilerCapability;
 
 import java.util.List;
-
-import org.apache.maven.project.MavenProject;
 
 /**
  * Provides factory services for creating capabilities (based on user-defined requirements)
for compilers and executables.

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/CompilerConfig.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/CompilerConfig.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/CompilerConfig.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/CompilerConfig.java
Mon Apr 23 18:05:32 2007
@@ -45,7 +45,12 @@
      * @return true if the compiler plugin should compile the test classes, otherwise returns
false.
      */
     boolean isTestCompile();
-    
+
+    /**
+     * Returns key info used for signing assemblies.
+     *
+     * @return key info used for signing assemblies
+     */
     KeyInfo getKeyInfo();
 
     /**
@@ -76,6 +81,11 @@
      */
     void setLocalRepository( File localRepository );
 
+    /**
+     * Sets key info used for signing assemblies.
+     *
+     * @param keyInfo key info used for signing assemblies
+     */
     void setKeyInfo(KeyInfo keyInfo);
 
 }

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/KeyInfo.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/KeyInfo.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/KeyInfo.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/KeyInfo.java
Mon Apr 23 18:05:32 2007
@@ -1,9 +1,42 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.executable.compiler;
 
+/**
+ * Provides services for obtaining information about the key file.
+ *
+ * @author Shane Isbell
+ */
 public interface KeyInfo
 {
+    /**
+     * Returns the path of the key
+     *
+     * @return the path of the key
+     */
     String getKeyFileUri();
 
+    /**
+     * Sets the path of the key
+     *
+     * @param keyFileUri the path of the key
+     */
     void setKeyFileUri(String keyFileUri);
 
     String getKeyContainerName();
@@ -28,7 +61,6 @@
         {
             return new KeyInfo()
             {
-
                 private String keyFileUri;
 
                 private String keyContainerName;

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/BaseCompiler.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/BaseCompiler.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/BaseCompiler.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/BaseCompiler.java
Mon Apr 23 18:05:32 2007
@@ -1,3 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.executable.compiler.impl;
 
 import org.apache.maven.dotnet.executable.compiler.CompilerContext;
@@ -12,12 +30,21 @@
 import java.util.List;
 
 /**
+ * Provides an implementation of the compiler executable.
  *
+ * @author Shane Isbell
  */
+//TODO: Describe how this class should be extended
 abstract class BaseCompiler implements CompilerExecutable
 {
+    /**
+     * The context that the compiler implementation can use to obtain information to customize
the compile.
+     */
     protected CompilerContext compilerContext;
 
+    /**
+     * A logger for writing log messages
+     */
     protected Logger logger;
 
     /**
@@ -29,6 +56,9 @@
         this.logger = nmavenContext.getLogger();
     }
 
+    /**
+     * @see org.apache.maven.dotnet.executable.compiler.CompilerExecutable#getCompiledArtifact()
+     */
     public File getCompiledArtifact()
         throws InvalidArtifactException
     {
@@ -41,6 +71,9 @@
         return file;
     }
 
+    /**
+     * @see org.apache.maven.dotnet.executable.compiler.CompilerExecutable#getExecutable()
+     */
     public String getExecutable()
         throws ExecutionException
     {
@@ -51,6 +84,9 @@
         return compilerContext.getCompilerCapability().getExecutable();
     }
 
+    /**
+     * @see org.apache.maven.dotnet.executable.compiler.CompilerExecutable#getExecutionPath()
+     */
     public File getExecutionPath()
     {
         String executable;
@@ -77,6 +113,9 @@
         return null;
     }
 
+    /**
+     * @see org.apache.maven.dotnet.executable.compiler.CompilerExecutable#execute()
+     */
     public void execute()
         throws ExecutionException
     {

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/CSharpCompilerForProfile.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/CSharpCompilerForProfile.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/CSharpCompilerForProfile.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/CSharpCompilerForProfile.java
Mon Apr 23 18:05:32 2007
@@ -34,7 +34,6 @@
 public final class CSharpCompilerForProfile
     extends BaseCompiler
 {
-
     private NetExecutable netCompiler;
 
     private CompilerContext compilerContext;

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/DotGNUCompiler.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/DotGNUCompiler.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/DotGNUCompiler.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/DotGNUCompiler.java
Mon Apr 23 18:05:32 2007
@@ -36,7 +36,6 @@
 public final class DotGNUCompiler
     extends BaseCompiler
 {
-
     public boolean failOnErrorOutput()
     {
         return true;

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/RubyCompiler.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/RubyCompiler.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/RubyCompiler.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/compiler/impl/RubyCompiler.java
Mon Apr 23 18:05:32 2007
@@ -1,3 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.executable.compiler.impl;
 
 import org.apache.maven.dotnet.executable.ExecutionException;
@@ -8,6 +26,12 @@
 import java.util.ArrayList;
 import java.io.File;
 
+/**
+ * Compiles ruby classes.
+ *
+ * @author Shane Isbell
+ */
+//TODO: Partial implementation
 public final class RubyCompiler
     extends BaseCompiler
 {

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CapabilityMatcherImpl.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CapabilityMatcherImpl.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CapabilityMatcherImpl.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CapabilityMatcherImpl.java
Mon Apr 23 18:05:32 2007
@@ -37,6 +37,9 @@
 public class CapabilityMatcherImpl
     implements CapabilityMatcher, LogEnabled
 {
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     private RepositoryRegistry repositoryRegistry;

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerContextImpl.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerContextImpl.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerContextImpl.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerContextImpl.java
Mon Apr 23 18:05:32 2007
@@ -41,12 +41,16 @@
 import java.io.File;
 
 /**
+ * Provides an implementation of the Compiler Context.
+ *
  * @author Shane Isbell
  */
 public final class CompilerContextImpl
     implements CompilerContext, LogEnabled
 {
-
+    /**
+     * The maven project
+     */
     private MavenProject project;
 
     private CompilerConfig config;
@@ -67,6 +71,9 @@
 
     private RepositoryRegistry repositoryRegistry;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     private List<File> linkedResources;

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerPluginsRepository.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerPluginsRepository.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerPluginsRepository.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/CompilerPluginsRepository.java
Mon Apr 23 18:05:32 2007
@@ -38,7 +38,6 @@
 import org.apache.maven.dotnet.model.compiler.plugins.Platform;
 import org.apache.maven.dotnet.model.compiler.plugins.CommandFilter;
 
-
 /**
  * Repository for reading and providing access to the compiler-plugins.xml config file.
  *
@@ -47,9 +46,15 @@
 public final class CompilerPluginsRepository
     implements Repository
 {
-
+    /**
+     * List<org.apache.maven.dotnet.model.compiler.plugins.CompilerPlugin> of compiler
plugins pulled from the 
+     * compiler-plugins.xml file.
+     */
     private List compilerPlugins;
 
+    /**
+     * @see Repository#load(java.io.InputStream, java.util.Hashtable)
+     */
     public void load( InputStream inputStream, Hashtable properties )
         throws IOException
     {
@@ -68,6 +73,9 @@
         compilerPlugins = plugins.getCompilerPlugins();
     }
 
+    /**
+     * @see Repository#setRepositoryRegistry(org.apache.maven.dotnet.registry.RepositoryRegistry)
+     */
     public void setRepositoryRegistry( RepositoryRegistry repositoryRegistry )
     {
     }

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultNetExecutable.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultNetExecutable.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultNetExecutable.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultNetExecutable.java
Mon Apr 23 18:05:32 2007
@@ -28,6 +28,8 @@
 import java.io.File;
 
 /**
+ * Provides the default implementation of the net executable.
+ *
  * @author Shane Isbell
  */
 public class DefaultNetExecutable
@@ -38,6 +40,9 @@
 
     private MavenProject project;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     public List<String> getCommands()

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultRepositoryNetExecutable.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultRepositoryNetExecutable.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultRepositoryNetExecutable.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/DefaultRepositoryNetExecutable.java
Mon Apr 23 18:05:32 2007
@@ -37,8 +37,14 @@
 
     private RepositoryExecutableContext executableContext;
 
+    /**
+     * The maven project
+     */
     private MavenProject project;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     public List<String> getCommands()

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutableContextImpl.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutableContextImpl.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutableContextImpl.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutableContextImpl.java
Mon Apr 23 18:05:32 2007
@@ -28,6 +28,7 @@
 import org.codehaus.plexus.logging.LogEnabled;
 
 /**
+ * Provides an implementation of the executable context.
  *
  * @author Shane Isbell
  */
@@ -35,6 +36,9 @@
     implements ExecutableContext, LogEnabled
 {
 
+    /**
+     * The maven project
+     */
     private MavenProject project;
 
     private ExecutableRequirement executableRequirement;
@@ -49,6 +53,9 @@
 
     private ExecutableConfig executableConfig;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     public void enableLogging( Logger logger )

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutablePluginsRepository.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutablePluginsRepository.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutablePluginsRepository.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ExecutablePluginsRepository.java
Mon Apr 23 18:05:32 2007
@@ -38,12 +38,17 @@
 import org.apache.maven.dotnet.vendor.Vendor;
 
 /**
+ * Provides services for accessing the executable information within the executable-plugins.xml
file.
+ *
  * @author Shane Isbell
  */
 public final class ExecutablePluginsRepository
     implements Repository
 {
 
+    /**
+     * A list of executable capabilities as specified within the executable-plugins.xml file
+     */
     private List<ExecutablePlugin> executablePlugins;
 
     /**
@@ -75,6 +80,11 @@
     {
     }
 
+    /**
+     * Returns a list of executable capabilities as specified within the executable-plugins.xml
file.
+     *
+     * @return a list of executable capabilities as specified within the executable-plugins.xml
file
+     */
     List<ExecutableCapability> getCapabilities()
     {
         List<ExecutableCapability> platformCapabilities = new ArrayList<ExecutableCapability>();

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/NetExecutableFactoryImpl.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/NetExecutableFactoryImpl.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/NetExecutableFactoryImpl.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/NetExecutableFactoryImpl.java
Mon Apr 23 18:05:32 2007
@@ -49,6 +49,9 @@
     implements NetExecutableFactory, LogEnabled
 {
 
+    /**
+     * The capability matcher
+     */
     private CapabilityMatcher capabilityMatcher;
 
     private ArtifactContext artifactContext;
@@ -65,15 +68,22 @@
 
     private StateMachineProcessor processor;
 
+    /**
+     * A logger for writing log messages
+     */    
     private Logger logger;
 
+    /**
+     * @see LogEnabled#enableLogging(org.codehaus.plexus.logging.Logger)
+     */
     public void enableLogging( Logger logger )
     {
         this.logger = logger;
     }
 
     /**
-     * @see
+     * @see NetExecutableFactory#getCompilerExecutableFor(org.apache.maven.dotnet.executable.compiler.CompilerRequirement,
+     *      org.apache.maven.dotnet.executable.compiler.CompilerConfig, org.apache.maven.project.MavenProject,
java.io.File)
      */
     public CompilerExecutable getCompilerExecutableFor( CompilerRequirement compilerRequirement,
                                                         CompilerConfig compilerConfig, MavenProject
project,
@@ -158,6 +168,10 @@
         }
     }
 
+    /**
+     * @see NetExecutableFactory#getPluginLoaderFor(String, String, org.apache.maven.dotnet.vendor.VendorInfo,
+     *      org.apache.maven.project.MavenProject, String, java.io.File, String)
+     */
     public NetExecutable getPluginLoaderFor( String groupId, String artifactId, VendorInfo
vendorInfo,
                                              MavenProject project, String localRepository,
File parameterFile,
                                              String mojoName )
@@ -188,6 +202,10 @@
                                                localRepository, commands );
     }
 
+    /**
+     * @see NetExecutableFactory#getNetExecutableFromRepository(String, String, org.apache.maven.dotnet.vendor.VendorInfo,
+     *      org.apache.maven.project.MavenProject, String, java.util.List<String>)
+     */
     public NetExecutable getNetExecutableFromRepository( String groupId, String artifactId,
VendorInfo vendorInfo,
                                                          MavenProject project, String localRepository,
                                                          List<String> commands )
@@ -285,6 +303,9 @@
 
     }
 
+    /**
+     * @see NetExecutableFactory
+     */
     public NetExecutable getNetExecutableFor( String vendor, String frameworkVersion, String
profile,
                                               MavenProject project, List<String> commands,
File netHome )
         throws PlatformUnsupportedException

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/RepositoryExecutableContextImpl.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/RepositoryExecutableContextImpl.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/RepositoryExecutableContextImpl.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/RepositoryExecutableContextImpl.java
Mon Apr 23 18:05:32 2007
@@ -29,6 +29,7 @@
 import org.apache.maven.dotnet.registry.Repository;
 
 /**
+ * Provides an implementation of the repository executable context.
  *
  * @author Shane Isbell
  */
@@ -36,6 +37,9 @@
     implements RepositoryExecutableContext, LogEnabled
 {
 
+    /**
+     * The maven project
+     */
     private MavenProject project;
 
     private RepositoryRegistry repositoryRegistry;
@@ -44,8 +48,14 @@
 
     private ExecutableConfig executableConfig;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
+    /**
+     * @see LogEnabled#enableLogging(org.codehaus.plexus.logging.Logger)
+     */
     public void enableLogging( Logger logger )
     {
         this.logger = logger;

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ThreadedNetExecutable.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ThreadedNetExecutable.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ThreadedNetExecutable.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-executable/src/main/java/org/apache/maven/dotnet/executable/impl/ThreadedNetExecutable.java
Mon Apr 23 18:05:32 2007
@@ -1,3 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.executable.impl;
 
 import org.apache.maven.dotnet.executable.NetExecutable;
@@ -12,14 +30,25 @@
 import java.util.List;
 import java.io.File;
 
-
+/**
+ * Provides a service for executing a command within a separate thread. This will be used
for executing long-running
+ * processes.
+ *
+ * @author Shane Isbell
+ */
 public class ThreadedNetExecutable
     implements NetExecutable, Runnable
 {
     private ExecutableContext executableContext;
 
+    /**
+     * The maven project
+     */
     private MavenProject project;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     public void run()

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/AbstractMojo.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/AbstractMojo.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/AbstractMojo.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/AbstractMojo.java
Mon Apr 23 18:05:32 2007
@@ -1,3 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.plugin;
 
 import org.apache.maven.plugin.MojoExecutionException;
@@ -23,11 +41,23 @@
 import java.io.FileOutputStream;
 import java.io.IOException;
 
+/**
+ * The base class for plugins that execute a .NET plugin. Classes that extend this class
are only expected to provide
+ * information (through the abstract methods) to this base class implementation.
+ *
+ * @author Shane Isbell
+ */
 public abstract class AbstractMojo
     extends org.apache.maven.plugin.AbstractMojo
     implements DotNetMojo
 {
-    public void execute()
+    /**
+     * Executes the mojo.
+     *
+     * @throws MojoExecutionException
+     * @throws MojoFailureException
+     */
+    public final void execute()
         throws MojoExecutionException, MojoFailureException
     {
         DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
@@ -100,12 +130,24 @@
         }
     }
 
+    /**
+     * @see org.apache.maven.dotnet.plugin.DotNetMojo#getLocalRepository()
+     */
     public abstract String getLocalRepository();
 
+    /**
+     * @see DotNetMojo#getMavenProject()
+     */
     public abstract MavenProject getMavenProject();
 
+    /**
+     * @see DotNetMojo#getDOMSourceFor(org.w3c.dom.Document)
+     */
     public abstract DOMSource getDOMSourceFor( Document document );
 
+    /**
+     * @see org.apache.maven.dotnet.plugin.DotNetMojo#getNetExecutableFactory() 
+     */
     public abstract NetExecutableFactory getNetExecutableFactory();
 
 }

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/DotNetMojo.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/DotNetMojo.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/DotNetMojo.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-plugin/src/main/java/org/apache/maven/dotnet/plugin/DotNetMojo.java
Mon Apr 23 18:05:32 2007
@@ -1,3 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.plugin;
 
 import org.apache.maven.project.MavenProject;
@@ -6,6 +24,13 @@
 
 import javax.xml.transform.dom.DOMSource;
 
+/**
+ * Provides services for the base abstract mojo to use in configuring the plugin environment.
The methods should be
+ * implemented by classes that extend the <code>AbstractMojo</code>
+ *
+ * @author Shane Isbell
+ */
+
 public interface DotNetMojo
 {
     /**
@@ -13,11 +38,33 @@
      */
     String ROLE = DotNetMojo.class.getName();
 
+    /**
+     * Returns the path to the local maven repository.
+     *
+     * @return the path to the local maven repository
+     */
     String getLocalRepository();
 
+    /**
+     * Returns the maven project
+     *
+     * @return the maven project
+     */
     MavenProject getMavenProject();
 
+    /**
+     * Returns the DOM source for the specified document. The source contains the parameters
that the .NET version of
+     * the AbstractMojo plugin will use for injecting field properties.
+     *
+     * @param document
+     * @return the DOM source for the specified document
+     */
     DOMSource getDOMSourceFor( Document document );
 
+    /**
+     * Returns the net executable factory
+     *
+     * @return the net executable factory
+     */
     NetExecutableFactory getNetExecutableFactory();
 }

Modified: incubator/nmaven/branches/SI_XPT/components/dotnet-vendor/src/test/java/org/apache/maven/dotnet/vendor/impl/MatchPolicyFactoryTest.java
URL: http://svn.apache.org/viewvc/incubator/nmaven/branches/SI_XPT/components/dotnet-vendor/src/test/java/org/apache/maven/dotnet/vendor/impl/MatchPolicyFactoryTest.java?view=diff&rev=531670&r1=531669&r2=531670
==============================================================================
--- incubator/nmaven/branches/SI_XPT/components/dotnet-vendor/src/test/java/org/apache/maven/dotnet/vendor/impl/MatchPolicyFactoryTest.java
(original)
+++ incubator/nmaven/branches/SI_XPT/components/dotnet-vendor/src/test/java/org/apache/maven/dotnet/vendor/impl/MatchPolicyFactoryTest.java
Mon Apr 23 18:05:32 2007
@@ -1,3 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
 package org.apache.maven.dotnet.vendor.impl;
 
 import junit.framework.TestCase;
@@ -8,11 +26,18 @@
 import org.apache.maven.dotnet.vendor.VendorTestFactory;
 import org.apache.maven.dotnet.vendor.Vendor;
 
+/**
+ *
+ * @author Shane Isbell
+ */
 public class MatchPolicyFactoryTest
     extends TestCase
 {
     private MatchPolicyFactory matchPolicyFactory;
 
+    /**
+     * A logger for writing log messages
+     */
     private Logger logger;
 
     public void setUp()



Mime
View raw message