1 /***************************************************************************** 2 * Copyright (c) 2000, 2003 IBM Corporation and others. 3 * All rights reserved. This program and the accompanying materials 4 * are made available under the terms of the Common Public License v1.0 5 * which accompanies this distribution, and is available at 6 * http://www.eclipse.org/legal/cpl-v10.html 7 * 8 * Contributors: 9 * IBM Corporation - initial API and implementation 10 *****************************************************************************/ 11 12 package net.sourceforge.phpdt.internal.ui.text.phpdoc; 13 14 /** 15 * Javadoc tag constants. 16 * 17 * @since 3.0 18 */ 19 public interface IJavaDocTagConstants { 20 21 /** Javadoc break tags */ 22 public static final String[] JAVADOC_BREAK_TAGS = new String[] { 23 "dd", "dt", "li", "td", "th", "tr", "h1", "h2", "h3", "h4", "h5", "h6", "q" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$ //$NON-NLS-10$ //$NON-NLS-11$ //$NON-NLS-12$ //$NON-NLS-13$ 24 25 /** Javadoc single break tag */ 26 public static final String[] JAVADOC_SINGLE_BREAK_TAG = new String[] { "br" }; //$NON-NLS-1$ 27 28 /** Javadoc code tags */ 29 public static final String[] JAVADOC_CODE_TAGS = new String[] { "pre" }; //$NON-NLS-1$ 30 31 /** Javadoc general tags */ 32 public static final String[] JAVADOC_GENERAL_TAGS = new String[] { 33 "@author", "@deprecated", "@exception", "@link", "@param", "@return", "@see", "@since", "@throws", "@value", "@version", "@license", "@abstract", "@access", "@category", 34 "@copyright", "@example", "@final", "@filesource", "@global", "@ignore", "@internal", "@link", "@method", "@name", "@package", "@param", "@property", "@static", 35 "@staticvar", "@subpackage", "@todo", "@tutorial", "@uses", "@var","@id", "inheritdoc", "@property-read", "@property-write", "@source"}; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$ //$NON-NLS-10$ //$NON-NLS-11$ //$NON-NLS-12$ //$NON-NLS-13$ //$NON-NLS-14$ //$NON-NLS-15$ //$NON-NLS-16$ //$NON-NLS-17$ //$NON-NLS-18$ 36 37 /** Javadoc immutable tags */ 38 public static final String[] JAVADOC_IMMUTABLE_TAGS = new String[] { 39 "code", "em", "pre", "q", "tt" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ 40 41 /** Javadoc link tags */ 42 public static final String[] JAVADOC_LINK_TAGS = new String[] { 43 "@docRoot", "@inheritDoc", "@link", "@linkplain" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ 44 45 /** Javadoc new line tags */ 46 public static final String[] JAVADOC_NEWLINE_TAGS = new String[] { 47 "dd", "dt", "li", "td", "th", "tr", "h1", "h2", "h3", "h4", "h5", "h6", "q" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$ //$NON-NLS-10$ //$NON-NLS-11$ //$NON-NLS-12$ //$NON-NLS-13$ 48 49 /** Javadoc parameter tags */ 50 public static final String[] JAVADOC_PARAM_TAGS = new String[] { 51 "@exception", "@param", "@serialField", "@throws" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ 52 53 /** Javadoc reference tags */ 54 public static final String[] JAVADOC_REFERENCE_TAGS = new String[] { "@see" }; //$NON-NLS-1$ 55 56 /** Javadoc root tags */ 57 public static final String[] JAVADOC_ROOT_TAGS = new String[] { 58 "@author", "@deprecated", "@return", "@see", "@serial", "@serialData", "@since", "@version", "@inheritDoc" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ //$NON-NLS-8$ //$NON-NLS-9$ 59 60 /** Javadoc separator tags */ 61 public static final String[] JAVADOC_SEPARATOR_TAGS = new String[] { 62 "dl", "hr", "nl", "p", "pre", "ul", "ol" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$ //$NON-NLS-5$ //$NON-NLS-6$ //$NON-NLS-7$ 63 64 /** Javadoc tag prefix */ 65 public static final char JAVADOC_TAG_PREFIX = '@'; 66 } 67