Fixes to javadoc linting errors

[matgallacher]

Minor changes to the javadoc to fix the issue #4

[googlebot]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed, please reply here (e.g. I signed it!) and we'll verify. Thanks.

---

• If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
• If you signed the CLA as a corporation, please let us know the company's name.

[matgallacher]

I signed it!

[googlebot]

We found a Contributor License Agreement for you (the sender of this pull request), but were unable to find agreements for the commit author(s). If you authored these, maybe you used a different email address in the git commits than was used to sign the CLA (login here to double check)? If these were authored by someone else, then they will need to sign a CLA as well, and confirm that they're okay with these being contributed to Google.

[jpd236]

Thanks for sending this out - code looks good to me. Let me know if you're having trouble figuring out what needs to be done with the CLA. At a glance, it seems like the commit is associated with an email that isn't tied to any GitHub account, so either changing the commit to use the same email as your GitHub account, or associating that email with your account and signing the CLA with it should resolve the problem.

[matgallacher]

Is it possible there was a timing issue with the CLA?

[jpd236]

There's a little "?" next to the name at:

c99606b

if you hover over it, it mentions the email associated with the commit and says it's not associated with any GitHub account, which seems problematic to me. If you don't think that's related, and the email mentioned there has signed the CLA, then I can look further into it from our side.

[matgallacher]

I can't see the "?", if it is showing a gmail.com email it is correct, if it is showing blackbay.com that would be an issue

[jpd236]

It's showing @hgl.com. Question mark here, for reference:

What I'd do is amend your commit with:

git commit --amend --author="FirstName LastName <email@gmail.com>"

(editing the author portion as appropriate)

then git push -f to force-push the new commit here. You can edit the name/email for future commits using git config user.name "FirstName LastName" and git config user.email "email@gmail.com" (or add --global to set these as the default for all git repositories on your machine).

[matgallacher]

That sounds like a domain thing on my side - I think it might be an idea to abandon this and I'll redo the changes on my personal PC, they really aren't big changes!

[matgallacher]

I'm closing this so I can resubmit with the correct details