Java Documentation Suggestions

Discussion in 'Client & Site Suggestions' started by Arbiter, Mar 9, 2014.

  1. Arbiter

    Arbiter Mod Automation

    Joined:
    Jul 26, 2013
    Messages:
    2,653
    Likes Received:
    1,132
    In order to make the Java Documentation as comprehensive as possible for our developers, we are asking for suggestions of specific classes/methods to expand upon. Just provide a brief description below and we will address it promptly.

    Thanks.
     
  2. Arbiter

    Arbiter Mod Automation

    Joined:
    Jul 26, 2013
    Messages:
    2,653
    Likes Received:
    1,132
    @Cloud Execution class needs specification as to which unit of time is used for delays (milliseconds) as requested by @Salvation.
     
  3. Trigoon

    Joined:
    Oct 14, 2014
    Messages:
    8
    Likes Received:
    3
    The whole API should be documented thoroughly, I have not yet seen a botting client with a flush and complete API with rich documentation.
     
  4. Cloud

    Joined:
    Jul 28, 2013
    Messages:
    2,623
    Likes Received:
    964
    Although I agree, it takes a considerable amount of time to do detailed and proper documentation. I do try to add more documentation periodically however I'm aware there are sections that are still lacking. If there's ever a point that you find problematic, please comment and I'll gladly write some up.
     
  5. Calle

    Joined:
    Nov 23, 2013
    Messages:
    51
    Likes Received:
    10
    asign bot authors to do it, especially the ones that are very familiar with the api
     
  6. Cloud

    Joined:
    Jul 28, 2013
    Messages:
    2,623
    Likes Received:
    964
    That can't really be done in any productive way because the javadocs have to be packaged with the source code.
     
  7. Calle

    Joined:
    Nov 23, 2013
    Messages:
    51
    Likes Received:
    10
    damn :/
     
  8. Cloud

    Joined:
    Jul 28, 2013
    Messages:
    2,623
    Likes Received:
    964
    Feel free to point out specific sections that you feel are under documented. Anything that's self explanatory will be gradually filled out but right now I'm most worried about things that aren't clear enough.
     
  9. Defeat3d

    Defeat3d Prime Celestial

    Joined:
    Oct 30, 2014
    Messages:
    1,533
    Likes Received:
    675
    Docs need an update I think, World class doesn't exist anymore. Took me a while to find out.
     
  10. Cloud

    Joined:
    Jul 28, 2013
    Messages:
    2,623
    Likes Received:
    964
    Updated.
     
  11. SuperBotter

    SuperBotter Super Bot Author

    Joined:
    Jun 24, 2016
    Messages:
    131
    Likes Received:
    49
    ClientUI.showAlert() could be described. It's the green notification bar on the top of the RuneMate window, right?
     
  12. Snufalufugus

    Joined:
    Aug 23, 2015
    Messages:
    1,663
    Likes Received:
    730
    Almost the entirety of
    • com.runemate.game.api.hybrid.player_sense.PlayerSense.Key
    It has literally no information for most keys besides their names.
    --- Double Post Merged, Apr 20, 2017, Original Post Date: Mar 30, 2017 ---
    Inside of "Magic" there is:
    activate
    public boolean activate()

    For most spells this is enough, but it's not clear to authors that they can put the action into activate() to specify what to cast in the case of multiple spells being on the same icon.
     
    Jux7apose likes this.
  13. Savior

    Joined:
    Nov 17, 2014
    Messages:
    4,053
    Likes Received:
    1,640
    ItemEvents of both onItemAdded and onItemRemoved have positive values as quantityChange.
    You may want to document that, since intuitively an ItemEvent's quantityChange should be negative, so that event.getType() returns REMOVAL.
     
    Snufalufugus likes this.
  14. Derk

    Derk 12 year old normie

    Joined:
    Jan 8, 2015
    Messages:
    2,419
    Likes Received:
    889
    To be fair it's a quantity CHANGE, and all changes of values are positive, whether you substract or add.

    But your point is still valid. Document that shieeeet.
     
  15. Savior

    Joined:
    Nov 17, 2014
    Messages:
    4,053
    Likes Received:
    1,640
    [​IMG]
     
  16. Snufalufugus

    Joined:
    Aug 23, 2015
    Messages:
    1,663
    Likes Received:
    730
    SpriteItem class:

    derive(int quantity) - absolutely no idea what this does...
    getOrigin() - no idea...
    hasDynamicBounds() - links to Interactable, where the method is also blank

    Suggestions:
    getIndex() - no description
    "Gets the inventory slot, from 0 -> 27 numbered from left to right and top to bottom, that the spriteitem is contained by"

    getBounds() - no description
    "Gets the InteractableRectangle that encompasses the inventory slot containing the sprite item"
    or
    "Gets the InteractableRectangle that encompasses the sprite item"
    depending on which it does
    --- Double Post Merged, Mar 22, 2018, Original Post Date: Mar 15, 2018 ---
    WorldHop class:
    Should specify that for OSRS, you need to include the full world number. It's unintuitive since the world hop interface itself doesn't show the full world number when hopping to a new world.
     

Share This Page

Loading...