1 /* 2 * Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package com.sun.tools.doclets.internal.toolkit.taglets; 27 28 import java.util.Map; 29 import com.sun.javadoc.Tag; 30 import com.sun.tools.doclets.internal.toolkit.Content; 31 32 /** 33 * An inline Taglet used to index word or a phrase. 34 * The enclosed text is interpreted as not containing HTML markup or 35 * nested javadoc tags. 36 * 37 * @author Bhavesh Patel 38 */ 39 40 public class IndexTaglet extends BaseInlineTaglet { 41 42 private static final String NAME = "index"; 43 44 public static void register(Map<String, Taglet> map) { 45 map.remove(NAME); 46 map.put(NAME, new IndexTaglet()); 47 } 48 49 public String getName() { 50 return NAME; 51 } 52 53 /** 54 * {@inheritDoc} 55 */ 56 public Content getTagletOutput(Tag tag, TagletWriter writer) { 57 return writer.indexTagOutput(tag); 58 } 59 }