How To Install doclava-aosp on Ubuntu 18.04

In this tutorial we learn how to install doclava-aosp on Ubuntu 18.04. doclava-aosp is Custom Javadoc doclet by Google

Introduction

In this tutorial we learn how to install doclava-aosp on Ubuntu 18.04.

What is doclava-aosp

doclava-aosp is:

Key differences between Doclava and the standard doclet include:

  • Refreshed look and feel, including search capabilities
  • Embeds versioning information in the documentation
  • Uses a templating engine for user customizations
  • Throw build errors for things that can easily be caught, like @param tags that don’t match the parameter names.
  • Ability to include snippets of code from real source code
  • Federate documentation between multiple sites
  • Ability to embed javadocs in a larger web page.

This package is a fork of Doclava by The Android Open Source Project with special features for generating the source files of the Android platform framework API stubs “android.jar”.

There are three methods to install doclava-aosp on Ubuntu 18.04. We can use apt-get, apt and aptitude. In the following sections we will describe each method. You can choose one of them.

Install doclava-aosp Using apt-get

Update apt database with apt-get using the following command.

sudo apt-get update

After updating apt database, We can install doclava-aosp using apt-get by running the following command:

sudo apt-get -y install doclava-aosp

Install doclava-aosp Using apt

Update apt database with apt using the following command.

sudo apt update

After updating apt database, We can install doclava-aosp using apt by running the following command:

sudo apt -y install doclava-aosp

Install doclava-aosp Using aptitude

If you want to follow this method, you might need to install aptitude first since aptitude is usually not installed by default on Ubuntu. Update apt database with aptitude using the following command.

sudo aptitude update

After updating apt database, We can install doclava-aosp using aptitude by running the following command:

sudo aptitude -y install doclava-aosp

How To Uninstall doclava-aosp on Ubuntu 18.04

To uninstall only the doclava-aosp package we can use the following command:

sudo apt-get remove doclava-aosp

Uninstall doclava-aosp And Its Dependencies

To uninstall doclava-aosp and its dependencies that are no longer needed by Ubuntu 18.04, we can use the command below:

sudo apt-get -y autoremove doclava-aosp

Remove doclava-aosp Configurations and Data

To remove doclava-aosp configuration and data from Ubuntu 18.04 we can use the following command:

sudo apt-get -y purge doclava-aosp

Remove doclava-aosp configuration, data, and all of its dependencies

We can use the following command to remove doclava-aosp configurations, data and all of its dependencies, we can use the following command:

sudo apt-get -y autoremove --purge doclava-aosp

References

Summary

In this tutorial we learn how to install doclava-aosp package on Ubuntu 18.04 using different package management tools: apt, apt-get and aptitude.