search

nik312123 / Undyne

0 stars 0 forks source link

Doc custom attacks #104

Open akandikatla opened 5 years ago

akandikatla commented 5 years ago

Documented CustomAttackMaker package

nik312123 commented 5 years ago

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.