Exercises 3-13, 3-14 (Javadoc examples)

Chapter_3     Exercise_3-12

Exercise_3-15

---

---

Exercises 3-13, 3-14     TIJ, p. 61

Exercise 3-13: (1) Run Documentation1.java, Documentation2.java, and Documentation3.java through Javadoc. Verify the resulting documentation with your Web browser.
Exercise 3-14: (1) Add an HTML list of items to the documentation in the previous exercise.

CONTENTS:     Documentation1.java     Documentation2.java     Documentation3.java

Documentation1.java     TIJ, p. 56

/** A class comment */
public class Documentation1
{
/** A field comment */
public int i;

/** A method comment */
public void f() {}
}
/*
javac Documentation1.java
java Documentation1 // runtime error: no main()

javadoc Documentation1.java -d doc1

javadoc Documentation1.java -d doc1 \
-link https://docs.oracle.com/en/java/javase/21/docs/api/
*/

Notes:

If you want to run the program, type in the terminal
java Documentation1
(ignoring the comment)  // runtime error: no main()
Look also over the Notes at the end of the previous exercise (Exercise_3-12).

---

---

Documentation2.java     TIJ, p. 56

import java.util.Date;

public class Documentation2
{
/**
* <pre>
* {@link java.lang.System System}.out.println(new {@link java.util.Date Date}());
* </pre>
*/
public static void main(String[] args)
{
System.out.println(new Date());
}
}
/*
javac Documentation2.java
java Documentation2
Fri Jul 14 17:26:38 EEST 2023

javadoc Documentation2.java -d doc2

javadoc Documentation2.java -d doc2 \
-link https://docs.oracle.com/en/java/javase/21/docs/api/
*/

---

---

Documentation3.java     TIJ, p. 57

/**
* You can <em>even</em> insert a list:
* <ol>
* <li> Item one
* <li> Item two
* <li> Item three
* </ol>
*/
public class Documentation3 {}
/*
javac Documentation3.java
java Documentation3 // runtime error: no main()

javadoc Documentation3.java -d doc3

javadoc Documentation3.java -d doc3 \
-link https://docs.oracle.com/en/java/javase/21/docs/api/
*/

---

---

Chapter_3     Exercise_3-12

BACK_TO_TOP

Exercise_3-15