Bukkit Needs JavaDocs [nvm]

Discussion in 'Plugin Development' started by Mike111177, Jul 21, 2012.

Thread Status:
Not open for further replies.
  1. Offline

    Mike111177

    Have you ever noticed that for most java methods in eclipse when you hover over them you see this (for the example toString())
    Code:
    toLowerCase
    public String toLowerCase()
    Converts all of the characters in this String to lower case using the rules of the default locale. This is equivalent to calling toLowerCase(Locale.getDefault()). 
    Note: This method is locale sensitive, and may produce unexpected results if used for strings that are intended to be interpreted locale independently. Examples are programming language identifiers, protocol keys, and HTML tags. For instance, "TITLE".toLowerCase() in a Turkish locale returns "t?tle", where '?' is the LATIN SMALL LETTER DOTLESS I character. To obtain correct results for locale insensitive strings, use toLowerCase(Locale.ENGLISH). 
    
    
    
    Returns:
    the String, converted to lowercase.
    See Also:
    toLowerCase(Locale)
    
    or
    Untitled.png
    This is because java documents their programs well from within them. Any good coder documents there work well enough for people who understand how java works can figure it out. Javas favorite method to do this is by using JavaDocs which make it so that when you are using a Java IDE you can quickly get a basic understanding of any built in method. Now it is possible to do the same thing with bukkit or any program so that if the devs forget the order of some methods variables all he or she has to do is click on the method.
    Here is an example of a JavaDoc i have made for my plugin:
    Untitled2.png
    As you can see all i have to do is click on it and i instantly get instructions on how to use it. Creating these instruction wasn't that hard either all i had to do was add a few lines before my method which were automatically generated by simply writing
    Code:
    /***
    and hitting enter. Its then a "fill in the blank".
    Untitled3.png
    Now this is very easy to implement into any program. To the bukkit developers, i highly suggest making JavaDocs. They make coding so much faster for plugin devs so they don't have to go to the wiki every time they forget how to use a method.
     
  2. Offline

    aPunch

  3. Offline

    McLuke500

    That's a very detailed post when you could of just google'd "bukkit javadocs" and find it.
     
  4. Offline

    Mike111177

    Why Google it if you could just click on it and you instantly find out how to use it. I mainly say this because i travel a lot and i don't always have access to the internet. Plus it is a very easy thing to do.
     
  5. Offline

    V10lator

    <Edit by Moderator: Redacted bit url>
     
    Last edited by a moderator: Feb 19, 2017
  6. Offline

    obnoxint

    Almost all methods of the Bukkit API are documented. JavaDocs are comments and comments will be removed by the compiler. You need to link the JavaDocs manually by editing your buildpath properties.
     
  7. Offline

    mbaxter ʇıʞʞnq ɐ sɐɥ ı Retired Staff

    Moved to plugin dev section in case anyone else has trouble linking the javadocs
     
  8. Offline

    ferrybig

    I can see the javadocs from my ide, mayby you should also configure it correctly, Mike111177
     
  9. Offline

    Mike111177

    how do i do that
     
  10. Offline

    McLuke500

    ... You could of googled it and got the same answer he gave you i wasn't telling you to google it because you already had the answer and that would be stupid I was saying you could of googled before asking...

    http://wiki.bukkit.org/Plugin_Tutorial#Bukkit_Javadocs

    You should read the whole tutorial it's useful...

    EDIT by Moderator: merged posts, please use the edit button instead of double posting.
     
    Last edited by a moderator: May 27, 2016
Thread Status:
Not open for further replies.

Share This Page