Skip to content

Add a doc about the Custom Javadoc Tags feature #1085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amandelpie merged 4 commits into from
Nov 2, 2022
Merged

Add a doc about the Custom Javadoc Tags feature #1085

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a62a47e
Add a doc about the Custom Javadoc Tags feature
onewhl Oct 4, 2022
296e028
Format content
onewhl Oct 4, 2022
b3dfeb8
Add pictures
onewhl Oct 7, 2022
3a707fb
Merge branch 'main' into zarina/doc
onewhl Oct 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Format content
  • Loading branch information
@onewhl
onewhl committed Oct 4, 2022
commit 296e0287ceb8e5d477ba1e9cf2aa74c815b8e31f
15 changes: 7 additions & 8 deletions docs/summaries/CustomJavadocTags.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,22 +30,21 @@ the same names).
There is a setting `Javadoc comment style` in the main plugin's `Settings`. It has two options: `Plain` text
and `Structured via custom Javadoc tags` (selected by default).

## Examples: Summaries without custom tags/With custom tags

## View
There are two modes the comment could be shown in IntelliJ IDEA: plain text and rendered view.
To activate rendered mode, click on the toggle near comment.

| Version | Old | New |
|----------|-----|-----|
| Plain | | |
| Rendered | | |
To activate rendered mode, click on the toggle near comment.

## Implementation details

Implemented `JavadocTagInfo` to introduce our custom JavaDoc tags.

Implemented `CustomJavadocTagProvider` and registered it in `plugin.xml` to support plugin's custom tags.

Overrided behavior of `JavaDocumentationProvider#generateRenderedDoc` and registered it in `plugin.xml` to render our custom JavaDoc tags correctly.
Added a flag `USE_CUSTOM_TAGS` to settings

Added a flag `USE_CUSTOM_TAGS` to settings.

After plugin's removal, IDE doesn't recognize our custom tags. It doesn't lead to errors, but highlights tags with
yellow color.

Expand Down