Linked Questions
12 questions linked to/from How to reference a method in javadoc?
215 votes
4 answers
125k views
Javadoc @see or {@link}?
Could someone tell me the difference between javadoc @see and {@link}? Or rather, when to use which of them?
74 votes
3 answers
49k views
How do I refer to another typescript type in comments/JSDoc?
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} */ ...
19 votes
1 answer
42k views
Writing proper javadoc with @see?
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 ...
1 vote
1 answer
1k views
Javadoc @link different return-types
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 ...
0 votes
4 answers
908 views
What does # symbol mean in Java literature?
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: ...
1 vote
2 answers
2k views
Javadoc @link not working when referencing a vararg (String[]...)
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 ...
1 vote
2 answers
1k views
Add copyright at the end of Java class while writing documentation?
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?
1 vote
1 answer
555 views
Is it possible to get the same doc for overloaded methods?
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 ...
1 vote
1 answer
210 views
How to create link in Java-Doc?
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 ...
2 votes
0 answers
300 views
Javadoc Correct Formatting
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-...
1 vote
2 answers
148 views
Any trick in Android Studio IDE that will let you go to a method(); in the code by [CTRL]B when the //method() is in comment?
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]...
1 vote
0 answers
56 views
How to refrence to a method or a block in c commenting
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. ...