XR3Player icon indicating copy to clipboard operation
XR3Player copied to clipboard

Published 20 hours ago • verified publisher icon goxr3plus

Complete/Fix/Standardize JavaDoc

Open Valkryst opened this issue 7 years ago • 4 comments

  1. Write JavaDoc comments for all class variables and functions.
  2. In many cases, there are multi-line JavaDoc comments where the opening /** and closing */ could be moved onto the same line as the comment itself.
  3. There are functions with unfinished JavaDoc comments.
  4. JavaDoc comments on classes can be removed if they have no useful information (Ex. A one-line description of the class and author tag).

Valkryst avatar Oct 18 '17 15:10 Valkryst

Adding new features very quickly has made me to leave some methods without JavaDoc . The application is still in BETA so i try to find time to do all the above you mentioned .

I will follow your advices one by one :) !

goxr3plus avatar Oct 19 '17 15:10 goxr3plus

@Valkryst Hello i made a website for XR3Player :) you like it ? ( https://goxr3plus.github.io/xr3player.io/ )

goxr3plus avatar Nov 07 '17 23:11 goxr3plus

The first image in the slideshow took at-least 2 seconds to fully load (maybe look into compressing it) and the LOC metric at the bottom doesn't really mean anything to the user. Other than that, it's decent. GJ

Valkryst avatar Nov 08 '17 00:11 Valkryst

@Valkryst Thanks for testing it :).

1)I will transform. png images to. jpg images 2)On the LOC metric maybe I should add only total downloads. 3)Any recommendations you have please post them as an issue on the repository ( https://github.com/goxr3plus/xr3player.io) I WILL BE VERY GLAD TO ADD NEW THINGS :)

All the code of website is on that repository.

goxr3plus avatar Nov 08 '17 02:11 goxr3plus