Skip to content

Conversation

@Mart-Bogdan
Copy link

Fixed javadocs tags, that caused build errors while executing javadoc gradle task

P.S. do I need issue and CHANGELOG for this tiny fix?

@msftclas
Copy link

msftclas commented Feb 27, 2018

CLA assistant check
All CLA requirements met.

Copy link
Contributor

@dhaval24 dhaval24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Mart-Bogdan I don't think you need change logs. But I do have a fundamental question here. Why do we need to have this import statements if these classes are not used anywhere in the file. Just having imports for docs doesn't make sense and would add overhead. I did bit of search around this and seemed like older version of Java Docs had a bug regarding this but is no longer in later version.

@littleaj
Copy link
Contributor

@dhaval24 This is just what is needed. It either needs import statements or FQ name so the javadoc generator can find the symbols.

Also, import statements only affect compile time. There unused imports have no effect on bytecode.

@Mart-Bogdan
Copy link
Author

Hello, @dhaval24 , I uderstand why you are against imports, while it's not affecting generated code.

Issue I may think of is that IDE shows full class name in Doc explorer
image
In contrast of:
image

But I've decided to double-check, generated HTML documentation shows short names, so it seems ok:
image

It's no problem for me to change imports.

Just thought, perhaps some IDE unaware of doc coments removed "unused imports"?

So what reolution would be, I could specify types exactly,
but doing fillowing is unlikely {@link com.microsoft.applicationinsights.internal.channel.common.PartialSuccessHandler PartialSuccessHandler}

@dhaval24
Copy link
Contributor

@littleaj I disagree on this. I do not think that it is appropriate to keep the unused import statements in the code base. I think this is absolutely a bad practice and be it any phase (compile or runtime optimization should be emphasized). If we need to replace this by FQ names we should replace it with fully qualify names. Also I thought that this bug is more or less fixed.

https://bugs.java.com/view_bug.do?bug_id=4652655

@dhaval24
Copy link
Contributor

@Mart-Bogdan thank you for understanding the concerns here. I would personally much appreciate if you can change this to fully qualified names instead. I believe this was a bug way back and all modern industry IDEs including Intellij and Eclipse should have this in their latest releases fixed :)

@Mart-Bogdan Mart-Bogdan force-pushed the 2.0.0-STABLE_javadoc_fix branch from 6fda657 to 3a36070 Compare February 27, 2018 20:00
@Mart-Bogdan
Copy link
Author

@dhaval24 I've changed imports, as you suggested.

By the way, I'm pushing to 2.0.0-STABLE branch, don't know is that OK.

@littleaj littleaj dismissed dhaval24’s stale review February 27, 2018 22:49

we talked about it

Copy link
Contributor

@littleaj littleaj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this @Mart-Bogdan !

@littleaj littleaj merged commit 5c2a63a into microsoft:2.0.0-STABLE Feb 27, 2018
@Mart-Bogdan Mart-Bogdan deleted the 2.0.0-STABLE_javadoc_fix branch February 28, 2018 18:57
littleaj added a commit that referenced this pull request Mar 8, 2018
* Fix null ref check in telemetry correlation Utils (#541)

* Fix null ref check in TelemetryCorrelationUtils

* Modifying log level to warning

* Updating Changelog

* Fix handling of NaN and +/-Infinity in JSON serializer (#499)

* Handle NaN and +/-Infinity in metrics

* Default NaN/Infinity serialization to 0 to be consistent with other AI SDKs and make the code compatible with Java 6

* fixed javadoc errors and added section to generate pom.xml with all builds (#551)

* Updating version number to 2.0.0

* Implementing Retry logic [Reliable Channel] [STABLE Branch] (#561)

* Initial commit of retry and backoff logic fixes

* Fixing warnings on files I touched this round

* Fix the eclipse UI from screaming about the docker Contstants

* Fixed backoff logic to use existing method. Added more logging to the sender channel.

* Added the partial response handler, more logging

* Added gson to core. Fixed backoff manager to keep original functionality. Added extension to return the timeout values as expected before.

* Added unit tests.

* Fixing string typed ArrayList<> to List<> per Dhaval

* Missed one

* Making tests consistent.

* Added javadoc comments, simplified logic for a few methods

* Added exception logging per @dhaval24. Fixed formatting on touched files

* Updates per last round of commits

Moved the Handlers out of the concrete package to the common package to keep the same consistency.  Removed a couple of unessecary methods. Added docs.

* Latest fixes

* Add MaxInstantRetry

Added MaxInstantRetry configuration to allow for instantaneous retry on a failed transmission.

* Javadoc Updates

Javadoc and formatting updates

* NumberFormatException fix

Added null check

* JavaDocs for TPM

* Fixing FixedRateSampling to work in old and new version of sampling (#540)

Overriding default sampling percentage when programatically specified sampling percentage by user.

* upgrade to logback v1.2.3 (#565)

* Reliable channel: replacing logAlways "TRACE" statements with "info" (#571)

* Reliable channel: close resources in finally block. (#572)

* Reliable channel: close resources in finally block.

* change logging to warning when closing resources

* Bugfix against retry logic (#576)

* Refactor

* BUGFIX Logic would never backoff

After adding the instant retry amount logic to the code this line of code could cause the transmissions to not back off.

* Changes requested

* Fixed javadocs tags, that caused build errors while executing `javadoc` gradle task (#578)

* Update Changelog

* Fix link in changelog

* Fix another link in changelog

* Update gradle.properties

* Fix customizing pom.xml in Gradle build (#582)

* Fix customizing pom.xml in Gradle build

* Insert license after 1. row in pom.xml

* Filter artifacts relocated by shadow task from pom dependencies

- match artifacts by groupId
- fixes #583 

* Generate a pom file "beside" the artifact jar file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants