4. Javadoc and API Documentation¶
Prerequisite Information
This tutorial assumes that the reader has a knowledge of basic Unix commands and experience working with a command-line text editor (e.g. emacs, vi, etc.). To get the most out of this tutorial, you should follow along and take notes.
This chapter is written under the assumption that you will fully engage with the material. In other words, it is not sufficient to skim-read the content. You should carefully read and process the commands presented in this chapter and try to create your own, taking notes as you go.
Help and Feedback
If you have any questions as you are working through the chapter, you are encouraged to post on the course Piazza page. Your questions will not only help you fill gaps in your knowledge but also give the authors and instructors insight on potential updates to the chapter.
Course-Specific Learning Outcomes
LO3.b: Create class, interface, method, and inline documentation that satisfies a set of requirements.
LO3.c: Generate user-facing API documentation for a software solution.