zdm/event-bus
zdm/event-bus
3
Fork 0
Code Issues 2 Pull Requests Releases 8 Wiki Activity

Support JDK-style Javadoc Tags #28

Merged
kske merged 1 commits from b/javadoc-tags into develop 2021-11-25 12:05:32 +01:00
Conversation 0 Commits 1 Files Changed 1 +22
kske commented 2021-11-24 11:32:47 +01:00
Owner
Copy Link

This PR adds support for the @apiNote, @implSpec and @implNote Javadoc tags in the Maven Javadoc plugin, which threw an error previously.

This PR adds support for the `@apiNote`, `@implSpec` and `@implNote` Javadoc tags in the Maven Javadoc plugin, which threw an error previously.
kske self-assigned this 2021-11-24 11:32:47 +01:00
kske added 1 commit 2021-11-24 11:32:47 +01:00
kske requested review from delvh 2021-11-24 11:32:53 +01:00
delvh approved these changes 2021-11-25 11:16:30 +01:00
pom.xml
@ -123,0 +136,4 @@
</tag>
<tag>
<name>implNote</name>
<placement>a</placement>
delvh commented 2021-11-25 11:16:22 +01:00
Owner
Copy Link

What does <placement>a</placement> do? Places it the head above, or what?

What does `<placement>a</placement>` do? Places it the head **a**bove, or what?
kske commented 2021-11-25 12:05:27 +01:00
Author
Owner
Copy Link

It defines on which elements the tag is permitted. See the Maven Javadoc Plugin Documentation.

It defines on which elements the tag is permitted. See the [Maven Javadoc Plugin Documentation](http://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#tags).
👍 1
delvh marked this conversation as resolved
kske merged commit 5ddef71c26 into develop 2021-11-25 12:05:32 +01:00
kske deleted branch b/javadoc-tags 2021-11-25 12:05:32 +01:00
Sign in to join this conversation.
Reviewers
No reviewers
delvh
Labels
Clear labels   
1

1

  
13

13

  
2

2

  
21

21

  
3

3

  
34

34

  
5

5

  
55

55

  
8

8

  
bug

Something isn't working

  
core

Event Bus Core

  
could have

This doesn't hurt

  
duplicate

This issue or pull request already exists

  
enhancement

New feature or request

  
help wanted

Extra attention is needed

  
must have

This is absolutely necessary

  
proc

Event Bus Proc

  
question

Further information is needed

  
should have

This should be implemented

  
wont have

This won't be implemented (for now)

  
L

Branches where 300 < X <= 600 lines are added and more than one work day is needed

  
M

Branches where 100 < X <=300 lines are added

  
S

Branches where X <= 100 lines are added or less than 30 minutes are needed

  
XL

Branch where X > 600 lines are added and more than two work days are needed

  
bug

Something is not working

  
bugfix

Fixes a bug

  
discussion

This has to be discussed

  
documentation

Related to documentation

  
feature

Introduces a new feature

  
maintenance

Related to project maintenance

  
postponed

Won't be done in the immediate future

  
refactoring

Refactoring code or architectures

  
wontfix

Will not be fixed in this state of development

No Label
1
13
2
21
3
34
5
55
8
bug
core
could have
duplicate
enhancement
help wanted
must have
proc
question
should have
wont have
L
M
S
XL
bug
bugfix
discussion
documentation
feature
maintenance
postponed
refactoring
wontfix
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
kske
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: zdm/event-bus#28
No description provided.
Delete Branch "b/javadoc-tags"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?