apache / apache/camel-quarkus

Remove javadoc @code and other oldfashioned styles

Open
#466 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
302
Forks
232
Avg merge
1d 22h
Merged PRs (30d)
108

Description

This makes little sense and today we want more basic javadoc as it works better for tooling such as in vscode etc.

eg notice the @code in the tooltip

![Screenshot 2019-11-23 at 11 41 49](https://user-images.githubusercontent.com/477100/69477414-5cdf5200-0de6-11ea-8c5d-f76e82594ef7.png)

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue identifies Javadoc styling and an example tooltip, but names no files or tests. Start by locating the affected Javadocs in the repository and checking how their rendered tooltips appear in the referenced tooling; done means the outdated styles are removed and the basic documentation renders as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.