Linked Questions

215 votes
4 answers
125k views

Could someone tell me the difference between javadoc @see and {@link}? Or rather, when to use which of them?
membersound's user avatar
  • 87.9k
74 votes
3 answers
49k views

I'm familiar with Javadoc. In Javadoc, you can place a link that refers to the Javadoc placed on another type like so: /** * some java thingy. see this other java thingy too {@link OtherThingy} */ ...
Rico Kahler's user avatar
  • 19.6k
19 votes
1 answer
42k views

How do I use the @see javadoc properly? My intention is to have an abstract class with abstract methods. These methods have javadoc comments. Now if I extend the abstract class, I override the ...
membersound's user avatar
  • 87.9k
1 vote
1 answer
1k views

The Javadoc of @link is pretty well explained in the two answers here, as well as in their given links. I have one question though: How can you distinguish the different return-type of an otherwise ...
Kevin Cruijssen's user avatar
0 votes
4 answers
908 views

I've noticed that the # symbol is commonly used in Java literature. Does it denote methods of class instances? Is this some kind of standard or convention? Here are examples of this symbol being used: ...
bezbos.'s user avatar
  • 2,484
1 vote
2 answers
2k views

I'm trying to generate a Javadoc for my project, but I can't seem to find how to create a link to a precise Method : public static Html select(Buffer<String> contentBuffer, String id, String ...
Zenoo's user avatar
  • 12.9k
1 vote
2 answers
1k views

I'm writing documentation for my java file. In that documentation, I want to add some html links at the end of each generated file. For that, what I have to use while writing java documentation?
Lakshmi Prasanna's user avatar
1 vote
1 answer
555 views

I'm searching the best way to make documentations with overloaded methods. I have two methods: /** * does something * @param A * @return result */ public String methodA(Type1 A); /** * does ...
merours's user avatar
  • 4,114
1 vote
1 answer
210 views

I want to create a link in Java-Doc for my methods and classes. Some methods use objects of another class. So I want to specify the link in the Java-Doc so that when user clicks on it, it'll open that ...
user3522978's user avatar
2 votes
0 answers
300 views

I am new to programming/Java and have been trying to teach myself it the last couple of weeks using some free textbooks and online resources. I thought a good way to learn would be to build a role-...
Fresh's user avatar
  • 87
1 vote
2 answers
148 views

As the topic. I'll repeat that because "As the topic." is less than 30 chars: Does anyone know the trick in Anenter code heredroid Studio IDE that will let you go to a method(); in the code by [CTRL]...
Pablo_xyu's user avatar
1 vote
0 answers
56 views

I know that we can use comments to refer to e.g. methods in java (see this). Is this option available in c too? Lots of time while commenting, for example, I have a bug that is handled after 10 lines. ...
Mohammad Kholghi's user avatar