IJavaDocTagConstants


1   /*******************************************************************************
2    * Copyright (c) 2000, 2007 IBM Corporation and others.
3    * All rights reserved. This program and the accompanying materials
4    * are made available under the terms of the Eclipse Public License v1.0
5    * which accompanies this distribution, and is available at
6    * http://www.eclipse.org/legal/epl-v10.html
7    *
8    * Contributors:
9    *     IBM Corporation - initial API and implementation
10   *******************************************************************************/
11  
12  package org.eclipse.jdt.internal.formatter.comment;
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 char[][] JAVADOC_BREAK_TAGS = new char[][] {
23          "dd".toCharArray(), //$NON-NLS-1$
24          "dt".toCharArray(), //$NON-NLS-1$
25          "li".toCharArray(), //$NON-NLS-1$
26          "td".toCharArray(), //$NON-NLS-1$
27          "th".toCharArray(), //$NON-NLS-1$
28          "tr".toCharArray(), //$NON-NLS-1$
29          "h1".toCharArray(), //$NON-NLS-1$
30          "h2".toCharArray(), //$NON-NLS-1$
31          "h3".toCharArray(), //$NON-NLS-1$
32          "h4".toCharArray(), //$NON-NLS-1$
33          "h5".toCharArray(), //$NON-NLS-1$
34          "h6".toCharArray(), //$NON-NLS-1$
35          "q".toCharArray() //$NON-NLS-1$
36      };
37  
38      /** Javadoc single break tag */
39      public static final char[][] JAVADOC_SINGLE_BREAK_TAG= new char[][] { "br".toCharArray() }; //$NON-NLS-1$
40  
41      /** Javadoc code tags */
42      public static final char[][] JAVADOC_CODE_TAGS= new char[][] { "pre".toCharArray() }; //$NON-NLS-1$
43  
44      /** Javadoc immutable tags */
45      public static final char[][] JAVADOC_IMMUTABLE_TAGS= new char[][] {
46              "code".toCharArray(), //$NON-NLS-1$
47              "em".toCharArray(), //$NON-NLS-1$
48              "pre".toCharArray(), //$NON-NLS-1$
49              "q".toCharArray(), //$NON-NLS-1$
50              "tt".toCharArray() //$NON-NLS-1$
51      };
52  
53      /** Javadoc new line tags */
54      public static final char[][] JAVADOC_NEWLINE_TAGS= new char[][] {
55              "dd".toCharArray(), //$NON-NLS-1$
56              "dt".toCharArray(), //$NON-NLS-1$
57              "li".toCharArray(), //$NON-NLS-1$
58              "td".toCharArray(), //$NON-NLS-1$
59              "th".toCharArray(), //$NON-NLS-1$
60              "tr".toCharArray(), //$NON-NLS-1$
61              "h1".toCharArray(), //$NON-NLS-1$
62              "h2".toCharArray(), //$NON-NLS-1$
63              "h3".toCharArray(), //$NON-NLS-1$
64              "h4".toCharArray(), //$NON-NLS-1$
65              "h5".toCharArray(), //$NON-NLS-1$
66              "h6".toCharArray(), //$NON-NLS-1$
67              "q".toCharArray() //$NON-NLS-1$
68      };
69  
70      /** Javadoc parameter tags */
71      public static final char[][] JAVADOC_PARAM_TAGS= new char[][] {
72              "@exception".toCharArray(), //$NON-NLS-1$
73              "@param".toCharArray(), //$NON-NLS-1$
74              "@serialField".toCharArray(), //$NON-NLS-1$
75              "@throws".toCharArray() //$NON-NLS-1$
76      };
77  
78      /** Javadoc separator tags */
79      public static final char[][] JAVADOC_SEPARATOR_TAGS= new char[][] {
80              "dl".toCharArray(), //$NON-NLS-1$
81              "hr".toCharArray(), //$NON-NLS-1$
82              "nl".toCharArray(), //$NON-NLS-1$
83              "p".toCharArray(), //$NON-NLS-1$
84              "pre".toCharArray(), //$NON-NLS-1$
85              "ul".toCharArray(), //$NON-NLS-1$
86              "ol".toCharArray() //$NON-NLS-1$
87      };
88  
89      /** Javadoc tag prefix */
90      public static final char JAVADOC_TAG_PREFIX= '@';
91  
92      /** Link tag postfix */
93      public static final char LINK_TAG_POSTFIX= '}';
94  
95      /** Link tag prefix */
96      public static final String   LINK_TAG_PREFIX_STRING = "{@"; //$NON-NLS-1$
97  
98      public static final char[] LINK_TAG_PREFIX= LINK_TAG_PREFIX_STRING.toCharArray();
99  
100     
101     /** Comment root tags */
102     public static final char[][] COMMENT_ROOT_TAGS= new char[][] {
103             "@deprecated".toCharArray(), //$NON-NLS-1$
104             "@see".toCharArray(), //$NON-NLS-1$
105             "@since".toCharArray(), //$NON-NLS-1$
106             "@version".toCharArray() //$NON-NLS-1$
107     };
108 
109     /** Tag prefix of comment tags */
110     public static final char COMMENT_TAG_PREFIX= '@';
111 }
112
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags