From: Florian Forster <octo@leeloo.lan.home.verplant.org>
Date: Tue, 24 Feb 2009 09:13:11 +0000 (+0100)
Subject: bindings/java/: CollectdMatchFactoryInterface: Add more JavaDoc.
X-Git-Tag: collectd-4.7.0~127^2~2
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=8fe1101910d3650cc59230ced5bb02a8eabe882e

bindings/java/: CollectdMatchFactoryInterface: Add more JavaDoc.
---

diff --git a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
index d2801a1f..7b1c71a4 100644
--- a/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
+++ b/bindings/java/org/collectd/api/CollectdMatchFactoryInterface.java
@@ -33,5 +33,17 @@ package org.collectd.api;
  */
 public interface CollectdMatchFactoryInterface
 {
+	/**
+	 * Create a new "match" object.
+	 *
+	 * This method uses the configuration provided as argument to create a
+	 * new object which must implement the {@link CollectdMatchInterface}
+	 * interface.
+	 *
+	 * This function corresponds to the <code>create</code> member of the
+	 * <code>src/filter_chain.h:match_proc_t</code> struct.
+	 *
+	 * @return New {@link CollectdMatchInterface} object.
+	 */
 	public CollectdMatchInterface createMatch (OConfigItem ci);
 }