1 /*
2 * License : The MIT License
3 * Copyright(c) 2020 Olyutorskii
4 */
5
6 package io.github.olyutorskii.ghmvnlibtmpl;
7
8 /*
9 0 1 2 3 4 5 6 7 8 9 0 1
10 12345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789
11 */
12
13 /**
14 * Class brief.
15 *
16 * <p>Class detail.
17 *
18 * @see java.lang.Object
19 * @see <a href="https://openjdk.java.net/">OpenJDK</a>
20 * @author Mr.author
21 */
22 public class JavaDoc {
23
24 public final String field = "abc";
25
26 /**
27 * Constructor.
28 */
29 public JavaDoc() {
30 }
31
32 /**
33 * Method brief.
34 *
35 * <p>Method detail.
36 *
37 * @param iVal argument detail
38 * @return return value detail
39 * @throws IllegalArgumentException exception detail
40 * @see #field
41 * @see #JavaDoc()
42 */
43 public int method1(int iVal) throws IllegalArgumentException {
44 return iVal + 1;
45 }
46
47 /**
48 * メソッド概略。
49 *
50 * <p>メソッド詳細。
51 */
52 public void methodJp() {
53 return;
54 }
55
56 /**
57 * Xxx.
58 *
59 * @deprecated too old.
60 */
61 @Deprecated
62 public void methodDeprecated() {
63 return;
64 }
65
66 /**
67 * Javadoc with image.
68 *
69 * <img src="doc-files/bluedia.png" alt="Blue Diamond">
70 */
71 public void methodImage() {
72
73 }
74
75 /**
76 * {@inheritDoc}
77 *
78 * <p>And more.
79 *
80 * @return {@inheritDoc}
81 * @see java.lang.Object#toString() superstring
82 */
83 @Override
84 public String toString() {
85 return super.toString();
86 }
87
88 /**
89 * public javadoc
90 * with no description for @param warning.
91 * @param publicArg
92 */
93 public void warnPublic(int publicArg) {
94 warnPrivate(publicArg);
95 return;
96 }
97
98 /**
99 * private javadoc
100 * with no description for @param warning.
101 * @param privateArg
102 */
103 private void warnPrivate(int privateArg) {
104 assert privateArg == privateArg;
105 return;
106 }
107
108 }