Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Complete/Fix/Standardize JavaDoc #4

Open
Valkryst opened this issue Oct 18, 2017 · 4 comments
Open

Complete/Fix/Standardize JavaDoc #4

Valkryst opened this issue Oct 18, 2017 · 4 comments

Comments

@Valkryst
Copy link

  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
Copy link
Owner

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
Copy link
Owner

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

@Valkryst
Copy link
Author

Valkryst commented Nov 8, 2017

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
Copy link
Owner

goxr3plus commented Nov 8, 2017

@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 goxr3plus self-assigned this Sep 10, 2019
@goxr3plus goxr3plus pinned this issue Sep 10, 2019
@goxr3plus goxr3plus unpinned this issue Sep 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants