Revision: 20035
http://sourceforge.net/p/gate/code/20035
Author: markagreenwood
Date: 2017-02-01 03:01:32 +0000 (Wed, 01 Feb 2017)
Log Message:
-----------
fixed a bunch of javadoc issues
Modified Paths:
--------------
gate/branches/sawdust2/gate-core/src/main/java/gate/Gate.java
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/CreoleAnnotationHandler.java
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Parameter.java
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Plugin.java
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/ResourceReference.java
Modified: gate/branches/sawdust2/gate-core/src/main/java/gate/Gate.java
===================================================================
--- gate/branches/sawdust2/gate-core/src/main/java/gate/Gate.java
2017-02-01 02:23:25 UTC (rev 20034)
+++ gate/branches/sawdust2/gate-core/src/main/java/gate/Gate.java
2017-02-01 03:01:32 UTC (rev 20035)
@@ -1118,8 +1118,8 @@
/**
* Adds the plugin to the list of known plugins.
*
- * @param pluginURL
- * the URL for the new plugin.
+ * @param plugin
+ * the plugin to add to the list of known plugins.
*/
public static void addKnownPlugin(Plugin plugin) {
if(knownPlugins.contains(plugin)) return;
@@ -1166,8 +1166,8 @@
* Adds a new directory to the list of plugins that are loaded automatically
* at start-up.
*
- * @param pluginUrl
- * the URL for the new plugin.
+ * @param plugin
+ * the plugin to add to the list of autoload plugins.
*/
public static void addAutoloadPlugin(Plugin plugin) {
@@ -1238,8 +1238,7 @@
* well - i.e. all the metadata relating to resources defined by this
* directory will be removed from memory.
*
- * @param pluginURL
- */
+ * @param plugin the the plugin to remove from the list of known plugins
public static void removeKnownPlugin(Plugin plugin) {
//pluginURL = normaliseCreoleUrl(pluginURL);
knownPlugins.remove(plugin);
@@ -1253,8 +1252,8 @@
* loaded automatically at system start-up. This will be reflected in the
* user's configuration data file.
*
- * @param pluginURL
- * the URL to be removed.
+ * @param plugin
+ * the plugin to remove from the list of autoload plugins
*/
public static void removeAutoloadPlugin(Plugin plugin) {
autoloadPlugins.remove(plugin);
Modified:
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/CreoleAnnotationHandler.java
===================================================================
---
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/CreoleAnnotationHandler.java
2017-02-01 02:23:25 UTC (rev 20034)
+++
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/CreoleAnnotationHandler.java
2017-02-01 03:01:32 UTC (rev 20035)
@@ -74,10 +74,10 @@
private Plugin plugin;
/**
- * Create an annotation handler for the given creole.xml file.
+ * Create an annotation handler for the given plugin
*
- * @param creoleFileUrl
- * location of the creole.xml file.
+ * @param plugin
+ * the plugin we are to process
*/
public CreoleAnnotationHandler(Plugin plugin) {
//this.creoleFileUrl = creoleFileUrl;
Modified:
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Parameter.java
===================================================================
--- gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Parameter.java
2017-02-01 02:23:25 UTC (rev 20034)
+++ gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Parameter.java
2017-02-01 03:01:32 UTC (rev 20035)
@@ -49,15 +49,11 @@
private static final long serialVersionUID = 6611664706992065985L;
/**
- * Constructor
- * @param baseUrl the URL to the creole.xml file that defines the resource
- * this parameter belongs to. This will be used a context when deriving
- * default values for the parameters of type URL.
- */
- /*public Parameter(URL baseUrl){
- this.baseURL = baseUrl;
- }*/
-
+ * Construct a new Parameter for a resource in a given plugin.
+ * @param plugin the plugin that defines the resource
+ * this parameter belongs to. This will be used as context when deriving
+ * default values for the parameters of type URL oe ResourceReference.
+ */
public Parameter(Plugin plugin) {
this.plugin = plugin;
}
Modified: gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Plugin.java
===================================================================
--- gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Plugin.java
2017-02-01 02:23:25 UTC (rev 20034)
+++ gate/branches/sawdust2/gate-core/src/main/java/gate/creole/Plugin.java
2017-02-01 03:01:32 UTC (rev 20035)
@@ -106,7 +106,7 @@
protected transient String name;
/**
- * The list of {@link Gate.ResourceInfo} objects within this plugin
+ * The list of {@link gate.Gate.ResourceInfo} objects within this plugin
*/
protected transient List<ResourceInfo> resourceInfoList = null;
Modified:
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/ResourceReference.java
===================================================================
---
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/ResourceReference.java
2017-02-01 02:23:25 UTC (rev 20034)
+++
gate/branches/sawdust2/gate-core/src/main/java/gate/creole/ResourceReference.java
2017-02-01 03:01:32 UTC (rev 20035)
@@ -203,7 +203,7 @@
}
/**
- * Creates a {@link java,net.URL URL} instance that can be used to access the
+ * Creates a {@link java.net.URL URL} instance that can be used to access the
* underlying resource. It should be noted that the result is not guaranteed
* to be valid long term and should never be persisted. If you want
persistent
* access then store the {@code ResourceReference} instance instead.
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, SlashDot.org! http://sdm.link/slashdot
_______________________________________________
GATE-cvs mailing list
GATE-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/gate-cvs
