changeset 1814:fd31bf97340f

8016193: Fix OAC issue in langtools docs Reviewed-by: darcy
author jjg
date Fri, 07 Jun 2013 15:35:38 -0700
parents 5b039297151e
children 105d1f9c1ab8 da8d0ee0938e
files src/share/classes/com/sun/javadoc/Tag.java
diffstat 1 files changed, 20 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/src/share/classes/com/sun/javadoc/Tag.java	Thu Jun 06 15:38:42 2013 +0100
+++ b/src/share/classes/com/sun/javadoc/Tag.java	Fri Jun 07 15:35:38 2013 -0700
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -54,36 +54,44 @@
      * <code>{&#064;link}</code>, the curly brackets
      * are not part of the name, so in this example the name
      * would be simply <code>@link</code>.
+     *
+     * @return the name of this tag
      */
     String name();
 
     /**
      * Return the containing {@link Doc} of this Tag element.
+     *
+     * @return the containing {@link Doc} of this Tag element
      */
     Doc holder();
 
     /**
      * Return the kind of this tag.
-     * similar or synonymous tags.  For most tags,
+     * For most tags,
      * <code>kind()&nbsp;==&nbsp;name()</code>;
      * the following table lists those cases where there is more
      * than one tag of a given kind:
      * <p>
-     * <table border="1" cellpadding="4" cellspacing="0">
-     * <tr><th><tt> kind()  </tt></th>  <th><tt> name()      </tt></th></tr>
-     * <tr><td><tt> @throws </tt></td>  <td><tt> @throws     </tt></td></tr>
-     * <tr><td><tt> @throws </tt></td>  <td><tt> @exception  </tt></td></tr>
-     * <tr><td><tt> @see    </tt></td>  <td><tt> @see        </tt></td></tr>
-     * <tr><td><tt> @see    </tt></td>  <td><tt> @link       </tt></td></tr>
-     * <tr><td><tt> @see    </tt></td>  <td><tt> @linkplain  </tt></td></tr>
-     * <tr><td><tt> @serial </tt></td>  <td><tt> @serial     </tt></td></tr>
-     * <tr><td><tt> @serial </tt></td>  <td><tt> @serialData </tt></td></tr>
+     * <table border="1" cellpadding="4" cellspacing="0" summary="related tags">
+     * <tr><th>{@code kind()  }</th>  <th>{@code name()      }</th></tr>
+     * <tr><td>{@code @throws }</td>  <td>{@code @throws     }</td></tr>
+     * <tr><td>{@code @throws }</td>  <td>{@code @exception  }</td></tr>
+     * <tr><td>{@code @see    }</td>  <td>{@code @see        }</td></tr>
+     * <tr><td>{@code @see    }</td>  <td>{@code @link       }</td></tr>
+     * <tr><td>{@code @see    }</td>  <td>{@code @linkplain  }</td></tr>
+     * <tr><td>{@code @serial }</td>  <td>{@code @serial     }</td></tr>
+     * <tr><td>{@code @serial }</td>  <td>{@code @serialData }</td></tr>
      * </table>
+     *
+     * @return the kind of this tag.
      */
     String kind();
 
     /**
-     * Return the text of this tag, that is, portion beyond tag name.
+     * Return the text of this tag, that is, the portion beyond tag name.
+     *
+     * @return the text of this tag
      */
     String text();