Skip to main content
summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Goldthorpe2011-10-19 18:19:29 +0000
committerChris Goldthorpe2011-10-19 18:19:29 +0000
commitb775d76514d15bc83a014ed8c7009e96a09c5dec (patch)
tree03d013dab655364606a95957273eb28d8cccf596 /org.eclipse.help
parent5519734d70494c3f7c798fd2cd55d89feb0702c7 (diff)
downloadeclipse.platform.ua-b775d76514d15bc83a014ed8c7009e96a09c5dec.tar.gz
eclipse.platform.ua-b775d76514d15bc83a014ed8c7009e96a09c5dec.tar.xz
eclipse.platform.ua-b775d76514d15bc83a014ed8c7009e96a09c5dec.zip
Bug 351176 - [Doc] NullPointerException when implementing
IContext.getRelatedTopics to return null
Diffstat (limited to 'org.eclipse.help')
-rw-r--r--org.eclipse.help/src/org/eclipse/help/IContext.java9
1 files changed, 5 insertions, 4 deletions
diff --git a/org.eclipse.help/src/org/eclipse/help/IContext.java b/org.eclipse.help/src/org/eclipse/help/IContext.java
index 607d90303..24ad628c7 100644
--- a/org.eclipse.help/src/org/eclipse/help/IContext.java
+++ b/org.eclipse.help/src/org/eclipse/help/IContext.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2005 IBM Corporation and others.
+ * Copyright (c) 2000, 2011 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@@ -31,10 +31,11 @@ package org.eclipse.help;
*/
public interface IContext {
/**
- * Returns a list of related topics for this help context.
+ * Returns the related topics for this help context.
*
- * @return a list of related help topics or <code>null</code>
- * if no related topics have been defined for this context.
+ * @return an array of related help topics.
+ * If no related topics have been defined for this context a zero length array is returned.
+ * May not return <code>null</code>
* @since 2.0
*/
public IHelpResource[] getRelatedTopics();

Back to the top