How To Install doclava on Debian 11

One-liner install command

For those in a hurry, here's a one-line installation command:

sudo apt-get update && sudo apt -y install doclava-aosp

But if you are interested in the detailed steps with descriptions, the following information is for you.

What is doclava and what are the ways to install it?

Before beginning this tutorial, you will need access to a server or computer running Debian 11. This guide was written specifically with a server running Debian 11 in mind, although it should also work on older, supported versions of the operating system.

Also, make sure you are running a regular, non-root user with sudo privileges configured on your server. When you have an account available, log in as your non-root user to begin.

There are several ways to install doclava on Debian 11. You can use (links are clickable):

In the following sections, we will describe each method in detail. You can choose one of them or refer to the recommended one.

Install doclava using apt-get

First, update apt database with apt-get using the following command.

sudo apt-get update

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

sudo apt -y install doclava-aosp

Install doclava using apt

Because doclava is available in Debian 11’s default repositories, it is possible to install it from these repositories using the apt packaging system.

To begin, update apt database with apt using the following command.

sudo apt update

After updating apt database, You can install doclava using apt by running the following command:

sudo apt -y install doclava-aosp

Install doclava 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 Debian 11. Update apt database with aptitude using the following command.

sudo aptitude update

After updating aptitude database, You can install doclava by running the following command:

sudo aptitude -y install doclava-aosp

How to upgrade (update) a single package doclava using apt-get?

First, you will need to update packages index. Run update command as usual:

sudo apt-get update

Next, to upgrade only the doclava, e.g. single package, you should use the following format with the apt-get command/apt command:

sudo apt-get --only-upgrade install doclava-aosp

Note that this command will not install any new packages! If you wish to install the package if it doesn't exist you may leave out --only-upgrade part.

sudo apt-get install doclava-aosp

How To Uninstall doclava from Debian 11

To uninstall only the doclava package you can execute the following command:

sudo apt-get remove doclava-aosp

Uninstall doclava and all its dependencies

To uninstall doclava and its dependencies that are no longer needed by Debian 11, you can use the command below:

sudo apt-get -y autoremove doclava-aosp

Remove doclava with all configurations and data

To remove doclava configuration and data from your system you can run the following purge command:

sudo apt-get -y purge doclava-aosp

Remove doclava completely (configurations, data and all of its dependencies)

And lastly, you can run the next command to remove absolutely everything related to doclava package, e.g.: configurations, data and all of its dependencies. Just use this command:

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

Extra info and code examples

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".

Conclusion

You now have a full guide on how to install doclava using apt, apt-get and aptitude tools. Also, we showed how to update as a single package and different ways to uninstall the doclava from Debian 11.

See also: