Thread: How to generate documentation

Results 1 to 1 of 1
  1. #1 How to generate documentation 
    Registered Member
    Join Date
    Jul 2012
    Age
    19
    Posts
    64
    Thanks given
    9
    Thanks received
    6
    Rep Power
    12
    EDIT: Maybe this should be moved to the programming section. I put it here because it was targetted at RS-servers.

    Requirements:
    • Any IDE: I'll be using intelliJ, because it's better (imo).
    • A commented source: People who don't comment their sources shouldn't do releases. I'll be using Kethsi, as it was the first one I found with comments.


    How to:
    Step one:
    Load your project into the IDE.

    Basically, just click import and click next.

    Step two:
    Find the "Generate JavaDoc" menu item. In intelliJ it will be under the menu-bar "tools".


    Step three:
    Choose a folder to generate the output to. I recommend you making a folder in your project.



    Step four:
    Now you can navigate to your JavaDoc, choose the index.html file, open it in a web-browser and take a look at it.



    Why would I want to do this?
    1. It'll give you an overviewable interface to navigate through your code - hence making it easier to find what you're looking for.
    2. If you're going through somebodies elses code, it'll be normal that you don't really know what it's doing. Here you can easily go through every class, packages and get yourself a better understanding of the already implemented methods.
    3. If you perhaps want to offer plugins for your clients, you could create public methods that will make up the "API" for the plugins.
    4. Readabiltity
    5. You can write code for a server without having access to the source code details.
    Reply With Quote  
     

  2. Thankful user:



Thread Information
Users Browsing this Thread

There are currently 1 users browsing this thread. (0 members and 1 guests)

Similar Threads

  1. Replies: 1
    Last Post: 07-09-2014, 12:47 PM
  2. [637/639] How to generate mapdata?
    By Kayla in forum Help
    Replies: 2
    Last Post: 10-14-2011, 01:07 PM
  3. [OpenRS Editor] How to generate the version table
    By Discardedx2 in forum Snippets
    Replies: 10
    Last Post: 06-26-2011, 01:46 AM
Posting Permissions
  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •