commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From marcospera...@apache.org
Subject svn commit: r1360728 - in /commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph: elo/KFactorBuilder.java export/DefaultExportSelector.java export/ExportSelector.java export/GraphExportException.java export/NamedExportSelector.java
Date Thu, 12 Jul 2012 15:38:01 GMT
Author: marcosperanza
Date: Thu Jul 12 15:38:00 2012
New Revision: 1360728

URL: http://svn.apache.org/viewvc?rev=1360728&view=rev
Log:
Filled some javadocs, no functional modifications

Modified:
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/KFactorBuilder.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/ExportSelector.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/GraphExportException.java
    commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/KFactorBuilder.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/KFactorBuilder.java?rev=1360728&r1=1360727&r2=1360728&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/KFactorBuilder.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/elo/KFactorBuilder.java
Thu Jul 12 15:38:00 2012
@@ -19,11 +19,22 @@ package org.apache.commons.graph.elo;
  * under the License.
  */
 
+/**
+ * TODO Fill me!!
+ * 
+ * @param <P>
+ */
 public interface KFactorBuilder<P>
 {
 
+    /**
+     * TODO Fill me!!
+     */
     void withDefaultKFactor();
 
+    /**
+     * TODO Fill me!!
+     */
     void withKFactor( int kFactor );
 
 }

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java?rev=1360728&r1=1360727&r2=1360728&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/DefaultExportSelector.java
Thu Jul 12 15:38:00 2012
@@ -23,6 +23,12 @@ import static org.apache.commons.graph.u
 
 import org.apache.commons.graph.Graph;
 
+/**
+ * TODO Fill me!!
+ *
+ * @param <V> the Graph vertices type.
+ * @param <E> the Graph edges type.
+ */
 public final class DefaultExportSelector<V, E>
     implements NamedExportSelector<V, E>
 {
@@ -31,21 +37,34 @@ public final class DefaultExportSelector
 
     private String name = null;
 
+    /**
+     * Creates  anew instance of export selector for the given graph
+     * @param graph the graph
+     */
     public DefaultExportSelector( Graph<V, E> graph )
     {
         this.graph = graph;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public DotExporter<V, E> usingDotNotation()
     {
         return new DotExporter<V, E>( graph, name );
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public GraphMLExporter<V, E> usingGraphMLFormat()
     {
         return new GraphMLExporter<V, E>( graph, name );
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public ExportSelector<V, E> withName( String name )
     {
         this.name = checkNotNull( name, "Graph name cannot be null." );

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/ExportSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/ExportSelector.java?rev=1360728&r1=1360727&r2=1360728&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/ExportSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/ExportSelector.java
Thu Jul 12 15:38:00 2012
@@ -19,17 +19,27 @@ package org.apache.commons.graph.export;
  * under the License.
  */
 
+/**
+ * TODO Fill me!!
+ * 
+ * @param <V> the Graph vertices type.
+ * @param <E> the Graph edges type.
+ */
 public interface ExportSelector<V, E>
 {
 
     /**
      * Export Graphs in <a href="http://en.wikipedia.org/wiki/DOT_language">DOT language</a>.
+     * @return {@link DotExporter} instance
+     * @throws GraphExportException
      */
     DotExporter<V, E> usingDotNotation()
         throws GraphExportException;
 
     /**
      * Export Graphs in <a href="http://graphml.graphdrawing.org/">GraphML file format</a>.
+     * @return {@link GraphMLExporter} instance
+     * @throws GraphExportException
      */
     GraphMLExporter<V, E> usingGraphMLFormat()
         throws GraphExportException;

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/GraphExportException.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/GraphExportException.java?rev=1360728&r1=1360727&r2=1360728&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/GraphExportException.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/GraphExportException.java
Thu Jul 12 15:38:00 2012
@@ -21,12 +21,24 @@ package org.apache.commons.graph.export;
 
 import static java.lang.String.format;
 
+/**
+ *  {@link GraphExportException} throws when some errors occurs during the graph export.
+ *
+ */
 public final class GraphExportException
     extends Exception
 {
 
     private static final long serialVersionUID = 1L;
 
+    /**
+     * Constructs a new graph export exception with the specified detail message.
+     * 
+     * @param cause the cause
+     * @param messagePattern  A <a href="../util/Formatter.html#syntax">format string</a>
+     * @param messageArguments Arguments referenced by the format specifiers in the format
string
+     * @see java.lang.String#format(String, Object...)
+     */
     public GraphExportException( Throwable cause, String messagePattern, Object...messageArguments
)
     {
         super( format( messagePattern, messageArguments ), cause );

Modified: commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
URL: http://svn.apache.org/viewvc/commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java?rev=1360728&r1=1360727&r2=1360728&view=diff
==============================================================================
--- commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
(original)
+++ commons/sandbox/graph/trunk/src/main/java/org/apache/commons/graph/export/NamedExportSelector.java
Thu Jul 12 15:38:00 2012
@@ -19,6 +19,12 @@ package org.apache.commons.graph.export;
  * under the License.
  */
 
+/**
+ * TODO Fill me!
+ *
+ * @param <V> the Graph vertices type.
+ * @param <E> the Graph edges type.
+ */
 public interface NamedExportSelector<V, E>
     extends ExportSelector<V, E>
 {



Mime
View raw message