Documentation JavaDoc - abdulmukit98/techshopJU GitHub Wiki

Generating JAVADoc documentation from Android Studio

Initially create a basic class for documentation

  package com.example.lab02;

  /**
   * Basic class to discuss documentation using JAVAdoc
   *
   * @author Abdul Mukit
   */

  public class basic {


      private int num1, num2, sum;

      /**
       * Setter for variable
       * @param num1 It is the first variable to get input from user
       */
      public void setNum1(int num1) 
      {
          this.num1 = num1;
      }

      /**
       * Setter for num2
       * @param num2 Second input variable
       */
      public void setNum2(int num2) 
      {
          this.num2 = num2;
      }

      /**
       * This function return summation of two number
       *
       * @param n1 Integer number on place of num1
       * @param n2 Any Integer
       * @return this function return summation of to parameter
       */
      public int summation (int n1, int n2)
      {
          return n1+n2;
      }

      /**
       * This setter method take two param.
       * Compute their summation
       * Assign the result to sum variable
       *
       * @param n1 any integer
       * @param n2 any integer
       */
      public void setSum(int n1, int n2) 
      {
          this.sum = summation(n1, n2);
      }
  }

Then Click Generate JavaDoc under Tool menu

JavaDoc Documentation is generated in html format