Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse MetaKeywords

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.util.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.

  • Konstruktordetails

  • Methodendetails

    • getMetaKeywords

      public List<String> getMetaKeywords(TypeElement typeElement)
      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 List<String> getClassKeyword(TypeElement typeElement)
      Get the current class for a meta tag keyword, as a singleton list.

    • getMetaKeywords

      public List<String> getMetaKeywords(PackageElement packageElement)
      Get the package keywords.

    • getMetaKeywordsForModule

      public List<String> getMetaKeywordsForModule(ModuleElement mdle)
      Get the module keywords.
      Parameter:
      mdle - the module being documented

    • getOverviewMetaKeywords

      public List<String> getOverviewMetaKeywords(String title, String docTitle)
      Get the overview keywords.

    • getMemberKeywords

      protected List<String> getMemberKeywords(List<? extends Element> members)
      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()

      Parameter:
      members - array of members to be added to keywords