search

goxr3plus / XR3Player

🎧 🎼 The MOST ADVANCED JavaFX Media Player
https://xr3player.netlify.com/
GNU Lesser General Public License v3.0
724 stars 175 forks source link

Complete/Fix/Standardize JavaDoc #4

Open Valkryst opened 7 years ago

Valkryst commented 7 years ago
  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).
goxr3plus commented 7 years ago

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 commented 7 years ago

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

Valkryst commented 7 years ago

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

goxr3plus commented 7 years ago

@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.