From 250afa7642a530e7c19ca491026b741815be764a Mon Sep 17 00:00:00 2001
From: akwizgran <akwizgran@users.sourceforge.net>
Date: Thu, 6 Mar 2014 13:20:28 +0000
Subject: [PATCH] Added javadoc comments to plugin factory interfaces.
---
.../briarproject/api/plugins/duplex/DuplexPluginFactory.java | 3 +++
.../briarproject/api/plugins/simplex/SimplexPluginFactory.java | 3 +++
2 files changed, 6 insertions(+)
diff --git a/briar-api/src/org/briarproject/api/plugins/duplex/DuplexPluginFactory.java b/briar-api/src/org/briarproject/api/plugins/duplex/DuplexPluginFactory.java
index 7e42b5b462..9e8cf70217 100644
--- a/briar-api/src/org/briarproject/api/plugins/duplex/DuplexPluginFactory.java
+++ b/briar-api/src/org/briarproject/api/plugins/duplex/DuplexPluginFactory.java
@@ -2,9 +2,12 @@ package org.briarproject.api.plugins.duplex;
import org.briarproject.api.TransportId;
+/** Factory for creating a plugin for a duplex transport. */
public interface DuplexPluginFactory {
+ /** Returns the plugin's transport identifier. */
TransportId getId();
+ /** Creates and returns a plugin, or null if no plugin can be created. */
DuplexPlugin createPlugin(DuplexPluginCallback callback);
}
diff --git a/briar-api/src/org/briarproject/api/plugins/simplex/SimplexPluginFactory.java b/briar-api/src/org/briarproject/api/plugins/simplex/SimplexPluginFactory.java
index b0c09575a6..bc5c955a52 100644
--- a/briar-api/src/org/briarproject/api/plugins/simplex/SimplexPluginFactory.java
+++ b/briar-api/src/org/briarproject/api/plugins/simplex/SimplexPluginFactory.java
@@ -2,9 +2,12 @@ package org.briarproject.api.plugins.simplex;
import org.briarproject.api.TransportId;
+/** Factory for creating a plugin for a simplex transport. */
public interface SimplexPluginFactory {
+ /** Returns the plugin's transport identifier. */
TransportId getId();
+ /** Creates and returns a plugin, or null if no plugin can be created. */
SimplexPlugin createPlugin(SimplexPluginCallback callback);
}
--
GitLab