org.freehep.tools.doclet
Class MetaKeywords

java.lang.Object
  org.freehep.tools.doclet.MetaKeywords

public class MetaKeywords

extends Object

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.

Author:

Doug Kramer

Source Code:

MetaKeywords.java

Constructor Summary

MetaKeywords(ConfigurationStandard configuration)
Constructor

Method Summary

protected ArrayList	getClassKeyword(com.sun.javadoc.ClassDoc classdoc) Get the current class for a meta tag keyword, as the first and only element of an array list.
protected ArrayList	getMemberKeywords(com.sun.javadoc.MemberDoc[] memberdocs) Get members for meta tag keywords as an array, where each member name is a string element of the array.
String[]	getMetaKeywords(com.sun.javadoc.ClassDoc classdoc) Returns an array of strings where each element is a class, method or field name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MetaKeywords

public MetaKeywords(ConfigurationStandard configuration)

Constructor

Method Detail

getMetaKeywords

public String[] getMetaKeywords(com.sun.javadoc.ClassDoc classdoc)

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.

getClassKeyword

protected ArrayList getClassKeyword(com.sun.javadoc.ClassDoc classdoc)

Get the current class for a meta tag keyword, as the first and only element of an array list.

getMemberKeywords

protected ArrayList getMemberKeywords(com.sun.javadoc.MemberDoc[] memberdocs)

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