Skip to content

Conversation

@akandikatla
Copy link
Collaborator

Documented CustomAttackMaker package

@nik312123 nik312123 self-requested a review January 11, 2019 04:21
@akandikatla akandikatla changed the base branch from master to develop January 11, 2019 04:22
nik312123 and others added 4 commits March 6, 2019 04:26
…tream to PrintWriter for custom attack creator, stopped block noise when increasing the game speed, changed timer to mainTimer for more human readability
@nik312123
Copy link
Owner

Hey, Aaron, I made a few changes to your docCustomAttacks branch. Here’s what’s left for you to do:

In general, add {@code ClassName} instead of just the class name

ArrowBar:
Add or make more clear the documentation for the draw method. Add inner comments to the constructor, NumberFieldFocus class, draw method, and setImage method.

AttackBar:
Add or make more clear the documentation for topBound (incorrect), bottomBound (incorrect), upScrollRect (no documentation), downScrollRect (no doc), dragArrowRect (no doc), getArrows (can be very similar to arrows description), add (no need to say when it runs), drawString (name and unclear doc), mouseClickWork (name and unclear doc), mouseDragWork (name and unclear doc), mouseReleased (name and unclear doc), mousePressed (name and unclear doc), and order (name and unclear doc), and order (you’re changing this up anyways) for the AttackBar. Also, add inner comments to draw, drawString, deleteAttackButton, orientationShiftButton, dropDownButton, drawArrows, mouseClickWork, mouseDragWork, and order.

CustomAttacks:
Improve the documentation for addAttack (incorrect), newThing (incorrect), importThing (incorrect), perform (name and unclear doc), startScreen (unclear doc), mouseWheelMoved (unclear doc), mouseDragged (unclear doc), mouseReleased (unclear doc), and mouseClicked (unclear doc). Also, add inner comments to perform, startScreen, addAttackButton, and mouseClicked.

BottomMenuBar:
Add or make more clear the documentation for mouseWorks (too vague). Add more inner documentation for the paintComponent method, drawBarCheck method, mouseWorks method.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants