Mercurial > jdk8-mips64-public > langtools / changeset

     1.1 --- a/src/share/classes/com/sun/javadoc/Tag.java	Thu Jun 06 15:38:42 2013 +0100
     1.2 +++ b/src/share/classes/com/sun/javadoc/Tag.java	Fri Jun 07 15:35:38 2013 -0700
     1.3 @@ -1,5 +1,5 @@
     1.4  /*
     1.5 - * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
     1.6 + * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
     1.7   * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     1.8   *
     1.9   * This code is free software; you can redistribute it and/or modify it
    1.10 @@ -54,36 +54,44 @@
    1.11       * <code>{&#064;link}</code>, the curly brackets
    1.12       * are not part of the name, so in this example the name
    1.13       * would be simply <code>@link</code>.
    1.14 +     *
    1.15 +     * @return the name of this tag
    1.16       */
    1.17      String name();
    1.18  
    1.19      /**
    1.20       * Return the containing {@link Doc} of this Tag element.
    1.21 +     *
    1.22 +     * @return the containing {@link Doc} of this Tag element
    1.23       */
    1.24      Doc holder();
    1.25  
    1.26      /**
    1.27       * Return the kind of this tag.
    1.28 -     * similar or synonymous tags.  For most tags,
    1.29 +     * For most tags,
    1.30       * <code>kind()&nbsp;==&nbsp;name()</code>;
    1.31       * the following table lists those cases where there is more
    1.32       * than one tag of a given kind:
    1.33       * <p>
    1.34 -     * <table border="1" cellpadding="4" cellspacing="0">
    1.35 -     * <tr><th><tt> kind()  </tt></th>  <th><tt> name()      </tt></th></tr>
    1.36 -     * <tr><td><tt> @throws </tt></td>  <td><tt> @throws     </tt></td></tr>
    1.37 -     * <tr><td><tt> @throws </tt></td>  <td><tt> @exception  </tt></td></tr>
    1.38 -     * <tr><td><tt> @see    </tt></td>  <td><tt> @see        </tt></td></tr>
    1.39 -     * <tr><td><tt> @see    </tt></td>  <td><tt> @link       </tt></td></tr>
    1.40 -     * <tr><td><tt> @see    </tt></td>  <td><tt> @linkplain  </tt></td></tr>
    1.41 -     * <tr><td><tt> @serial </tt></td>  <td><tt> @serial     </tt></td></tr>
    1.42 -     * <tr><td><tt> @serial </tt></td>  <td><tt> @serialData </tt></td></tr>
    1.43 +     * <table border="1" cellpadding="4" cellspacing="0" summary="related tags">
    1.44 +     * <tr><th>{@code kind()  }</th>  <th>{@code name()      }</th></tr>
    1.45 +     * <tr><td>{@code @throws }</td>  <td>{@code @throws     }</td></tr>
    1.46 +     * <tr><td>{@code @throws }</td>  <td>{@code @exception  }</td></tr>
    1.47 +     * <tr><td>{@code @see    }</td>  <td>{@code @see        }</td></tr>
    1.48 +     * <tr><td>{@code @see    }</td>  <td>{@code @link       }</td></tr>
    1.49 +     * <tr><td>{@code @see    }</td>  <td>{@code @linkplain  }</td></tr>
    1.50 +     * <tr><td>{@code @serial }</td>  <td>{@code @serial     }</td></tr>
    1.51 +     * <tr><td>{@code @serial }</td>  <td>{@code @serialData }</td></tr>
    1.52       * </table>
    1.53 +     *
    1.54 +     * @return the kind of this tag.
    1.55       */
    1.56      String kind();
    1.57  
    1.58      /**
    1.59 -     * Return the text of this tag, that is, portion beyond tag name.
    1.60 +     * Return the text of this tag, that is, the portion beyond tag name.
    1.61 +     *
    1.62 +     * @return the text of this tag
    1.63       */
    1.64      String text();
    1.65