apache / apache/beam

[Feature Request]: Enable display of @Description annotations in generated Javadocs

Open
#24,265 5 comments 0 reactions 0 assignees View on GitHub
java new feature P3 release website
Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
1d 20h
Merged PRs (30d)
196

Description

### What would you like to happen?

`*Option` classes contain `@Description` annotations which contain the details about the given option. But these annotations are no displayed in the generated Javadoc leading to poorly documented classes.

### Issue Priority

Priority: 2

### Issue Component

Component: release

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.