Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

add table with border per cell in javadoc

Tags:

java

javadoc

I know I can use html tags in Java docs. How do I add a table with borders for each cell? I want the cells to be align like a real table. I know the basic tags like

<table>
  <tr>
    <td> cell 11 </td> <td> cell 21</td>
  </tr>
  <tr>
    <td> cell 12 </td> <td> cell 22</td>
  </tr>
</table>

So how do I add borders and keep the table columns the same width?

like image 786
Nouvel Travay Avatar asked Oct 25 '16 23:10

Nouvel Travay


People also ask

What does @SEE mean in Javadoc?

In short, we use the @see tag when we want a link or a text entry that points to a reference. This tag adds a “See Also” heading to the reference. A document comment can hold any number of @see tags, all of which can be grouped under the same heading.

How do you use Javadoc tags?

You add Javadoc tags to classes, methods, and fields. For the @author and @version tags, add them only to classes and interfaces. The @param tags get added only to methods and constructors. The @return tag gets added only to methods.

How do you write a good Javadoc comment?

Use the standard style for the Javadoc comment Javadoc only requires a '/**' at the start and a '*/' at the end. In addition to this, use a single star on each additional line: /** * Standard comment. */ public ... /** Compressed comment.

Can you use HTML tags in Javadoc comments?

A Javadoc comment is written in HTML and can therefore use common HTML tags. A JavaDoc comment is made up of two parts, the description followed by block tags. Keep in mind that Javadoc is often read in it's source form, so it should be easy to read and understand without the generated web frontend.


1 Answers

Putting @RP's comment in an answer, you can use the border attribute for table like this:

<table border="1">
  <tr>
    <td> cell 11 </td> <td> cell 21</td>
  </tr>
  <tr>
    <td> cell 12 </td> <td> cell 22</td>
  </tr>
</table>
like image 156
Jay Whitsitt Avatar answered Sep 21 '22 08:09

Jay Whitsitt