From 3b9f0064088146b996e8571f492aa45ae639dbe7 Mon Sep 17 00:00:00 2001
From: buczekp <buczekp>
Date: Tue, 29 Mar 2011 12:50:24 +0000
Subject: [PATCH] minor: changed javadoc - moved notes out of the public
javadoc
SVN: 20542
---
.../shared/basic/dto/api/IManagedInputWidgetDescription.java | 3 +--
.../basic/dto/api/IManagedInputWidgetDescriptionFactory.java | 3 +--
.../shared/basic/dto/api/IManagedOutputWidgetDescription.java | 3 +--
.../openbis/generic/shared/basic/dto/api/IManagedProperty.java | 3 +--
.../openbis/generic/shared/basic/dto/api/IManagedUiAction.java | 3 +--
.../generic/shared/basic/dto/api/IManagedUiDescription.java | 1 +
.../generic/shared/basic/dto/api/IManagedUiTableAction.java | 3 +--
.../cisd/openbis/generic/shared/basic/dto/api/IPerson.java | 3 +--
.../cisd/openbis/generic/shared/basic/dto/api/ITableModel.java | 3 +--
.../generic/shared/basic/dto/api/ManagedInputFieldType.java | 3 +--
.../generic/shared/basic/dto/api/ManagedOutputWidgetType.java | 3 +--
.../basic/dto/api/ManagedTableActionRowSelectionType.java | 3 +--
.../shared/managed_property/api/EntityLinkElementKind.java | 3 +--
.../openbis/generic/shared/managed_property/api/IElement.java | 3 +--
.../generic/shared/managed_property/api/IElementFactory.java | 3 +--
.../managed_property/api/IEntityInformationProvider.java | 3 +--
.../shared/managed_property/api/IEntityLinkElement.java | 3 +--
.../shared/managed_property/api/IRowBuilderAdaptor.java | 3 +--
.../managed_property/api/ISimpleTableModelBuilderAdaptor.java | 3 +--
.../managed_property/api/IStructuredPropertyConverter.java | 3 +--
20 files changed, 20 insertions(+), 38 deletions(-)
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescription.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescription.java
index 911ed5d8644..2cbd184ca81 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescription.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescription.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Interface implemented by objects describing an input UI element (text field, combo box).
- * <p>
- * All methods of this interface are part of the Managed Properties API.
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedInputWidgetDescription extends ISerializable
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescriptionFactory.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescriptionFactory.java
index e08874838ed..c56a8259716 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescriptionFactory.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedInputWidgetDescriptionFactory.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Factory for creation of instances of {@link IManagedInputWidgetDescription}.
- * <p>
- * All methods of this interface are part of the Managed Properties API.
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedInputWidgetDescriptionFactory extends ISerializable
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedOutputWidgetDescription.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedOutputWidgetDescription.java
index 4a45a9f3aae..e647d91deb0 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedOutputWidgetDescription.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedOutputWidgetDescription.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Interface implemented by objects describing an output UI element (table, label).
- * <p>
- * All methods of this interface are part of the Managed Properties API.
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedOutputWidgetDescription extends ISerializable
{
/**
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedProperty.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedProperty.java
index e88c2d92a43..0d8c5e5e2c1 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedProperty.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedProperty.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Interface implemented by managed property.
- * <p>
- * All methods of this interface are part of the Managed Properties API.
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedProperty extends ISerializable
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiAction.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiAction.java
index e2a0bdd3f67..31371e43845 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiAction.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiAction.java
@@ -22,11 +22,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Description of action that a user can perform on the client side.
- * <p>
- * All methods of this interface are part of the Managed Properties API.
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedUiAction extends ISerializable
{
/** Returns string identifier of the action. */
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiDescription.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiDescription.java
index df89db8dec4..1e189d3c475 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiDescription.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiDescription.java
@@ -25,6 +25,7 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
*
* @author Chandrasekhar Ramakrishnan
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedUiDescription extends ISerializable
{
/**
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiTableAction.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiTableAction.java
index 6810a8e23e1..e63839c5da8 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiTableAction.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IManagedUiTableAction.java
@@ -27,12 +27,11 @@ import java.util.Map;
* <p>
* For actions that require single row to be selected it is possible to bind values of selected
* row's columns with input fields (e.g. useful in edit actions).
- * <p>
- * All methods of this interface are part of the Managed Properties API.
*
* @see ManagedTableActionRowSelectionType
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IManagedUiTableAction extends IManagedUiAction
{
/** Returns selection type specifying when the action should be enabled. */
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IPerson.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IPerson.java
index 593c44a8a6f..7837acf7a49 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IPerson.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/IPerson.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Representation of a user, e.g. one who modifies a property.
- * <p>
- * <b>All methods of this interface are part of the Managed Properties API.</b>
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IPerson extends ISerializable
{
/** @return id of the user */
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ITableModel.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ITableModel.java
index c9d232c672f..882014a3aca 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ITableModel.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ITableModel.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Interface implemented by table models.
- * <p>
- * NOTE: For now the interface is empty. It was introduced not to expose internal API.
*
* @author Piotr Buczek
*/
+// NOTE: For now the interface is empty. It was introduced not to expose internal API
public interface ITableModel extends ISerializable
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedInputFieldType.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedInputFieldType.java
index 69956c101c1..6d472aa58b2 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedInputFieldType.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedInputFieldType.java
@@ -19,10 +19,9 @@ package ch.systemsx.cisd.openbis.generic.shared.basic.dto.api;
import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
- * NOTE: This enumeration is part of the Managed Properties API.
- *
* @author Chandrasekhar Ramakrishnan
*/
+// NOTE: This enumeration is part of the Managed Properties API.
public enum ManagedInputFieldType implements ISerializable
{
TEXT, MULTILINE_TEXT, COMBO_BOX
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedOutputWidgetType.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedOutputWidgetType.java
index fb2d438dca9..60187549004 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedOutputWidgetType.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedOutputWidgetType.java
@@ -19,10 +19,9 @@ package ch.systemsx.cisd.openbis.generic.shared.basic.dto.api;
import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
- * NOTE: This enumeration is part of the Managed Properties API.
- *
* @author Piotr Buczek
*/
+// NOTE: This enumeration is part of the Managed Properties API.
public enum ManagedOutputWidgetType implements ISerializable
{
TABLE, LABEL;
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedTableActionRowSelectionType.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedTableActionRowSelectionType.java
index 1f8fdccddbc..26e139bb033 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedTableActionRowSelectionType.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/api/ManagedTableActionRowSelectionType.java
@@ -20,11 +20,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.ISerializable;
/**
* Selection modes of table actions.
- * <p>
- * NOTE: This enumeration is part of the Managed Properties API.
*
* @author Piotr Buczek
*/
+// NOTE: This enumeration is part of the Managed Properties API.
public enum ManagedTableActionRowSelectionType implements ISerializable
{
/** e.g. create/add action */
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/EntityLinkElementKind.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/EntityLinkElementKind.java
index 637a59ab57d..1cc88d3e6d7 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/EntityLinkElementKind.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/EntityLinkElementKind.java
@@ -18,11 +18,10 @@ package ch.systemsx.cisd.openbis.generic.shared.managed_property.api;
/**
* The type of an entity link.
- * <p>
- * NOTE: This enumeration is part of the Managed Properties API.
*
* @author Kaloyan Enimanev
*/
+// NOTE: This enum is part of the Managed Properties API.
public enum EntityLinkElementKind
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElement.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElement.java
index f5c35b29838..3fb13c82324 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElement.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElement.java
@@ -26,12 +26,11 @@ import java.util.Map;
* <p>
* {@link IElement}-s are meant to be used as a convenient, hierarchical property-value persistence
* technique for managed properties.
- * <p>
- * <b>All methods of this interface are part of the Managed Properties API.</b>
*
* @author Piotr Buczek
* @author Kaloyan Enimanev
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IElement
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElementFactory.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElementFactory.java
index d78be893ad8..ca1ea3bb521 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElementFactory.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IElementFactory.java
@@ -18,11 +18,10 @@ package ch.systemsx.cisd.openbis.generic.shared.managed_property.api;
/**
* Contains helper method to construct {@link IElement} instances.
- * <p>
- * <b>All methods of this enum are part of the Managed Properties API.</b>
*
* @author Kaloyan Enimanev
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IElementFactory
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityInformationProvider.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityInformationProvider.java
index 75f64702669..347af160395 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityInformationProvider.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityInformationProvider.java
@@ -18,11 +18,10 @@ package ch.systemsx.cisd.openbis.generic.shared.managed_property.api;
/**
* Provides required information about entities.
- * <p>
- * <b>All methods of this enum are part of the Managed Properties API.</b>
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IEntityInformationProvider
{
/**
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityLinkElement.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityLinkElement.java
index 391ceef7d68..9aed6a98b70 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityLinkElement.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IEntityLinkElement.java
@@ -18,11 +18,10 @@ package ch.systemsx.cisd.openbis.generic.shared.managed_property.api;
/**
* Denotes a link to an entity in the openBIS database.
- * <p>
- * <b>All methods of this enum are part of the Managed Properties API.</b>
*
* @author Kaloyan Enimanev
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IEntityLinkElement extends IElement
{
/**
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IRowBuilderAdaptor.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IRowBuilderAdaptor.java
index 591de197394..19a7d8d3dde 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IRowBuilderAdaptor.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IRowBuilderAdaptor.java
@@ -20,12 +20,11 @@ import java.util.Date;
/**
* Builder of a row of a simple table.
- * <p>
- * <b>All methods of this enum are part of the Managed Properties API.</b>
*
* @see ISimpleTableModelBuilderAdaptor
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IRowBuilderAdaptor
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/ISimpleTableModelBuilderAdaptor.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/ISimpleTableModelBuilderAdaptor.java
index 0ab800943b7..540fe223c71 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/ISimpleTableModelBuilderAdaptor.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/ISimpleTableModelBuilderAdaptor.java
@@ -21,11 +21,10 @@ import ch.systemsx.cisd.openbis.generic.shared.basic.dto.api.ITableModel;
/**
* Builder of simple table models. All column titles should be unique.
- * <p>
- * <b>All methods of this enum are part of the Managed Properties API.</b>
*
* @author Piotr Buczek
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface ISimpleTableModelBuilderAdaptor
{
diff --git a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IStructuredPropertyConverter.java b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IStructuredPropertyConverter.java
index a7c63ee69c3..04bb8861f6a 100644
--- a/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IStructuredPropertyConverter.java
+++ b/openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/managed_property/api/IStructuredPropertyConverter.java
@@ -23,11 +23,10 @@ import ch.systemsx.cisd.openbis.generic.shared.managed_property.structured.Eleme
/**
* Abstracts the conversion of {@link Element} objects to/from database strings.
- * <p>
- * <b>All methods of this enum are part of the Managed Properties API.</b>
*
* @author Kaloyan Enimanev
*/
+// NOTE: All methods of this interface are part of the Managed Properties API.
public interface IStructuredPropertyConverter
{
/**
--
GitLab