| java.lang.Object
 com.sun.tools.doclets.internal.toolkit.util.MetaKeywords
| MetaKeywords | | public class MetaKeywords (Code) | | Provides methods for creating an array of class, method and
field names to be included as meta keywords in the HTML header
of class pages. These keywords improve search results
on browsers that look for keywords.
This code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API
author:
Doug Kramer |
| getClassKeyword | | protected ArrayList getClassKeyword(ClassDoc classdoc)(Code) | | Get the current class for a meta tag keyword, as the first
and only element of an array list.
|
| getInstance | | public static MetaKeywords getInstance(Configuration configuration)(Code) | | Return an instance of MetaKeywords. This class is a singleton.
Parameters:
configuration - the current configuration of the doclet. |
| getMemberKeywords | | protected ArrayList getMemberKeywords(MemberDoc[] memberdocs)(Code) | | Get members for meta tag keywords as an array,
where each member name is a string element of the array.
The parameter lists are not included in the keywords;
therefore all overloaded methods are combined.
Example: getValue(Object) is returned in array as getValue()
Parameters:
memberdocs - array of MemberDoc objects to be added to keywords |
| getMetaKeywords | | public String[] getMetaKeywords(ClassDoc classdoc)(Code) | | Returns an array of strings where each element
is a class, method or field name. This array is
used to create one meta keyword tag for each element.
Method parameter lists are converted to "()" and
overloads are combined.
Constructors are not included because they have the same
name as the class, which is already included.
Nested class members are not included because their
definitions are on separate pages.
|
| getMetaKeywords | | public String[] getMetaKeywords(PackageDoc packageDoc)(Code) | | Get the package keywords.
|
| getOverviewMetaKeywords | | public String[] getOverviewMetaKeywords(String title, String docTitle)(Code) | | Get the overview keywords.
|
|
|