Android Studio中的JavaDoc @link包

Question

I need to link to a package in JavaDoc.

Example:

@param example description (see {@link com.example.packagename this})

With the code above, I get this message:

warning - Tag @link: reference not found: com.example.packagename

Linking to a class in the same package works fine, but I need to link directly to the package.

Answer 1

It's not possible with @link .

Create package.html file or a single package-info.java in your com.example.packagename

/**
 * This is packagename
 */
package com.example.packagename;

Then you can link to this package by using @see .

/**
 * @param example description
 * @see com.example.packagename
 */
void doWork(String example) {

}

Now you android studio will show the documentation as follow:

By clicking on com.example.packagename , the javadoc inside package-info.java will be shown.

Note: Instead of linking packagename directly, You can use <a> tag:

 * @see <a href="{@docRoot}/com/example/packagename/package-summary.html">Packagename</a>