[jira] [Commented] (SLING-12089) Jenkins: Generate javadocs to spot illegal javadoc markup in sources

2023-10-17 Thread Stefan Seifert (Jira)


[ 
https://issues.apache.org/jira/browse/SLING-12089?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17776056#comment-17776056
 ] 

Stefan Seifert commented on SLING-12089:


yes, it's really difficult to get those various IDE setting in sync - and often 
not possible to full extend.

> Jenkins: Generate javadocs to spot illegal javadoc markup in sources
> 
>
> Key: SLING-12089
> URL: https://issues.apache.org/jira/browse/SLING-12089
> Project: Sling
>  Issue Type: Improvement
>  Components: Tooling
>Reporter: Stefan Seifert
>Assignee: Stefan Seifert
>Priority: Major
> Attachments: image-2023-10-16-09-24-58-984.png
>
>
> if often happens that releases fail due to small javadoc errors, which get 
> obvious when the "javadoc:javadoc" goal is executed on the command line. but 
> this does not fail our CI builds, that's why it often goes unnoticed for 
> quite some time (also in PRs).
> we should add that goal to our default build goals in jenkins.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)


[jira] [Commented] (SLING-12089) Jenkins: Generate javadocs to spot illegal javadoc markup in sources

2023-10-16 Thread Mark Adamcin (Jira)


[ 
https://issues.apache.org/jira/browse/SLING-12089?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17775832#comment-17775832
 ] 

Mark Adamcin commented on SLING-12089:
--

[~sseifert] I think another piece of this to look into is a potential 
difference in behavior between Eclipse's Organize Imports and IntelliJ's 
Optimize Imports. IntelliJ doesn't remove imports that are only used in javadoc 
{{{@link}}} macros, but I think Eclipse might be doing that. 
{{javadoc:javadoc}} was passing on my branch when I ran it locally, but the 
javadoc seems to have needed correction after your "remove unused imports" 
commits.

I looked up what can be done for Intellij, and there is this option that I can 
change to always use FQNs in javadoc:

  !image-2023-10-16-09-24-58-984.png|width=543,height=372!

Maybe there is a setting in Eclipse to retain imports that are referenced in 
javadocs, or to modify the link to a fully-qualified form when the import is 
removed?

> Jenkins: Generate javadocs to spot illegal javadoc markup in sources
> 
>
> Key: SLING-12089
> URL: https://issues.apache.org/jira/browse/SLING-12089
> Project: Sling
>  Issue Type: Improvement
>  Components: Tooling
>Reporter: Stefan Seifert
>Assignee: Stefan Seifert
>Priority: Major
> Attachments: image-2023-10-16-09-24-58-984.png
>
>
> if often happens that releases fail due to small javadoc errors, which get 
> obvious when the "javadoc:javadoc" goal is executed on the command line. but 
> this does not fail our CI builds, that's why it often goes unnoticed for 
> quite some time (also in PRs).
> we should add that goal to our default build goals in jenkins.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)