duke@1: /* bpatel@1568: * Copyright (c) 2002, 2013, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@554: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@554: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@554: * or visit www.oracle.com if you need additional information or have any ohair@554: * questions. duke@1: */ duke@1: duke@1: package com.sun.tools.doclets.internal.toolkit.util; duke@1: jjg@1357: import java.util.*; jjg@1357: jjg@1357: import com.sun.javadoc.*; bpatel@1568: import com.sun.tools.javac.jvm.Profile; duke@1: import com.sun.tools.doclets.internal.toolkit.*; duke@1: duke@1: /** duke@1: * Provides methods for creating an array of class, method and duke@1: * field names to be included as meta keywords in the HTML header duke@1: * of class pages. These keywords improve search results duke@1: * on browsers that look for keywords. duke@1: * jjg@1359: *
This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
duke@1: *
duke@1: * @author Doug Kramer
duke@1: */
duke@1: public class MetaKeywords {
duke@1:
duke@1: /**
duke@1: * The global configuration information for this run.
duke@1: */
duke@1: private final Configuration configuration;
duke@1:
duke@1: /**
duke@1: * Constructor
duke@1: */
jjg@140: public MetaKeywords(Configuration configuration) {
duke@1: this.configuration = configuration;
duke@1: }
duke@1:
duke@1: /**
duke@1: * Returns an array of strings where each element
duke@1: * is a class, method or field name. This array is
duke@1: * used to create one meta keyword tag for each element.
duke@1: * Method parameter lists are converted to "()" and
duke@1: * overloads are combined.
duke@1: *
duke@1: * Constructors are not included because they have the same
duke@1: * name as the class, which is already included.
duke@1: * Nested class members are not included because their
duke@1: * definitions are on separate pages.
duke@1: */
duke@1: public String[] getMetaKeywords(ClassDoc classdoc) {
jjg@74: ArrayList
duke@1: * Example: getValue(Object) is returned in array as getValue()
duke@1: *
duke@1: * @param memberdocs array of MemberDoc objects to be added to keywords
duke@1: */
jjg@74: protected ArrayList