Package javadoc
Class JavadocExample3
- java.lang.Object
-
- javadoc.JavadocExample3
-
public class JavadocExample3 extends java.lang.Object
Very stupid, but well-documented class. This class is for education purposes only.- Version:
- 0.2
- Author:
- Georgiy Korneev
-
-
Field Summary
Fields Modifier and Type Field Description private static int
DEFAULT_VALUE
Default value forverySimpleMethod()
.
-
Constructor Summary
Constructors Constructor Description JavadocExample3()
The stupid class may not have a smart constructor, isn't it?JavadocExample3(int a, int b)
But even a stupid class may have a simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
complexMethod(int seed)
Deprecated.usebrand-new very complex method
instead.void
veryComplexMethod(int level, int seed)
Performs a very complex computation.int
verySimpleMethod()
Just returns a default value.
-
-
-
Field Detail
-
DEFAULT_VALUE
private static final int DEFAULT_VALUE
Default value forverySimpleMethod()
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JavadocExample3
public JavadocExample3()
The stupid class may not have a smart constructor, isn't it?
-
JavadocExample3
public JavadocExample3(int a, int b)
But even a stupid class may have a simple constructor.- Parameters:
a
- absolutely meaningless parameter.b
- another absolutely meaningless parameter.
-
-
Method Detail
-
veryComplexMethod
public void veryComplexMethod(int level, int seed) throws java.io.IOException
Performs a very complex computation. The computed value is ignored.- Parameters:
level
- complexity level.seed
- initial seed.- Throws:
java.io.IOException
- if an I/O error occurred.- Since:
- 0.2
- See Also:
verySimpleMethod()
-
complexMethod
@Deprecated public void complexMethod(int seed)
Deprecated.usebrand-new very complex method
instead.Perform complex computation.- Parameters:
seed
- initial seed.
-
verySimpleMethod
public int verySimpleMethod()
Just returns a default value. The default value is 10.- Returns:
- default value.
-
-