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.

Sign up for GitHub

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

Jump to bottom

Javadoc sanity check #35

Open

ljleppan opened this issue Aug 11, 2015 · 0 comments

Member

ljleppan commented Aug 11, 2015

Some of the Javadoc comments are out of date and contain false information. F.ex. see fi.helsinki.cs.tmc.core.commands.Command#L51-56, fi.helsinki.cs.tmc.core.commands.DownloadExercises#L119-124 and fi.helsinki.cs.tmc.core.exceptions.TmcCodeException. Furthermore, multiple classes have undocumented public methods. These need to be updated and documented.

It would also be nice if the comments used Javadoc tags, especially for links to other classes within the project.

UMTti added the in progress label

UMTti self-assigned this

UMTti removed the in progress label

UMTti removed their assignment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment