How can i create a documentation to my classes and methods in Android Studio?

Question

I'm new to android world, i was wondering if there is a way to a documentation to my class, so when i hover on the class object i will be able to retrieve the description like in the following image

enter image description here

in visual studio all i have to do is something like this :

    /// <summary>
    /// This is the Documentation 
    /// </summary>

i have tried this and it didn't work

LazyCat01 · Answer 1 · 2016-06-11T15:41:36.227

3

Feature you are talking about called JavaDoc:

/**
* This method adds two numbers
* @param a my param a
* @param b my param b
* @return result description
*/
public int add(int a, int b){
......

Details here.

edited Jun 11 '16 at 15:41

answered Oct 02 '14 at 19:49

LazyCat01

924
7
22

Thanks Works fine here is your first +1 welcome to Stackoverflow – Mina Gabriel Oct 02 '14 at 20:10

score 3 · Accepted Answer · answered Oct 02 '14 at 19:50

3

that's javadoc. You should type

/**
 *
 */

before the method declaration

Here you can find more information

answered Oct 02 '14 at 19:50

Blackbelt

152,872
27
286
297

i tried to add this right above my class and it didn't work – Mina Gabriel Oct 02 '14 at 20:03
this is what i get http://content.screencast.com/users/minagabriel/folders/Snagit/media/575ec3d4-5c82-474b-a94d-aebbcaee08ff/10.02.2014-16.04.png – Mina Gabriel Oct 02 '14 at 20:05
1

can you try with a method ? – Blackbelt Oct 02 '14 at 20:07
Yes it works with constructors isn't this strange! – Mina Gabriel Oct 02 '14 at 20:09

How can i create a documentation to my classes and methods in Android Studio?

2 Answers2