Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse JDT
Release 3.5

org.eclipse.jdt.ui
Class JavadocContentAccess

java.lang.Object
  extended by 
org.eclipse.jdt.ui.JavadocContentAccess

public class JavadocContentAccess
extends Object

Helper needed to get the content of a Javadoc comment.

This class is not intended to be subclassed or instantiated by clients.

Since:
3.1
Restriction:
This class is not intended to be subclassed by clients.
Restriction:
This class is not intended to be instantiated by clients.

Method Summary
static  Reader getContentReader ( IMember member, boolean allowInherited)
          Gets a reader for an IMember's Javadoc comment content from the source attachment.
static  Reader getHTMLContentReader ( IMember member, boolean allowInherited)
          Deprecated. As of 3.2, replaced by getHTMLContentReader(IMember, boolean, boolean)
static  Reader getHTMLContentReader ( IMember member, boolean allowInherited, boolean useAttachedJavadoc)
          Gets a reader for an IMember's Javadoc comment content from the source attachment.
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getContentReader

public static 
Reader getContentReader(
IMember member,
                                      boolean allowInherited)
                               throws 
JavaModelException
Gets a reader for an IMember's Javadoc comment content from the source attachment. The content does contain only the text from the comment without the Javadoc leading star characters. Returns null if the member does not contain a Javadoc comment or if no source is available.

Parameters:
member - The member to get the Javadoc of.
allowInherited - For methods with no (Javadoc) comment, the comment of the overridden class is returned if allowInherited is true.
Returns:
Returns a reader for the Javadoc comment content or null if the member does not contain a Javadoc comment or if no source is available
Throws:
JavaModelException - is thrown when the elements javadoc can not be accessed

getHTMLContentReader

public static 
Reader getHTMLContentReader(
IMember member,
                                          boolean allowInherited,
                                          boolean useAttachedJavadoc)
                                   throws 
JavaModelException
Gets a reader for an IMember's Javadoc comment content from the source attachment. and renders the tags in HTML. Returns null if the member does not contain a Javadoc comment or if no source is available.

Parameters:
member - the member to get the Javadoc of.
allowInherited - for methods with no (Javadoc) comment, the comment of the overridden class is returned if allowInherited is true
useAttachedJavadoc - if true Javadoc will be extracted from attached Javadoc if there's no source
Returns:
a reader for the Javadoc comment content in HTML or null if the member does not contain a Javadoc comment or if no source is available
Throws:
JavaModelException - is thrown when the elements Javadoc can not be accessed
Since:
3.2

getHTMLContentReader

public static 
Reader getHTMLContentReader(
IMember member,
                                          boolean allowInherited)
                                   throws 
JavaModelException
Deprecated. As of 3.2, replaced by getHTMLContentReader(IMember, boolean, boolean)

Gets a reader for an IMember's Javadoc comment content from the source attachment. and renders the tags in HTML. Returns null if the member does not contain a Javadoc comment or if no source is available.

Parameters:
member - The member to get the Javadoc of.
allowInherited - For methods with no (Javadoc) comment, the comment of the overridden class is returned if allowInherited is true.
Returns:
Returns a reader for the Javadoc comment content in HTML or null if the member does not contain a Javadoc comment or if no source is available
Throws:
JavaModelException - is thrown when the elements javadoc can not be accessed

Eclipse JDT
Release 3.5

Copyright (c) IBM Corp. and others 2000, 2008. All Rights Reserved.

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire