Skip to content

Commit

Permalink
Fix javadoc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
markozajc committed Apr 14, 2024
1 parent 45d596a commit afb1fe3
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
6 changes: 4 additions & 2 deletions src/main/java/org/eu/zajc/akiwrapper/Akiwrapper.java
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,17 @@
* {@link AkiwrapperBuilder}</li>
* <li>A {@link Query} from {@link #getCurrentQuery()} is displayed to the user.</li>
* <li>The program decides based on the type of the {@link Query}:</li>
* <ol>
* <li>
* <ul>
* <li>If it's a {@link Guess}, it's shown to the user and responded to with either
* {@link Guess#confirm()} or {@link Guess#reject()}. Confirming a guess is the lose
* condition and ends the game.</li>
* <li>If it's a {@link Question}, it's shown to the user and responded to with
* either {@link Question#answer(Answer)} or {@link Question#undoAnswer()}.</li>
* <li>If it's {@code null}, Akinator has no more queries. This is the win
* condition.</li>
* </ol>
* </ul>
* </li>
* </ol>
* Queries can either be retrieved from return values of interaction methods
* ({@link Question#answer(Answer)}, {@link Question#undoAnswer()}, etc.) or from
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public interface Question extends Query {
* Returns the question text that should be displayed to the user. This is localized
* to the {@link Language} and in line with the {@link Theme} set in the
* {@link AkiwrapperBuilder}.
* <h2>Example</h2> {@code Is your character real?}
* <h4>Example</h4> {@code Is your character real?}
*
* @return the question text.
*/
Expand All @@ -118,7 +118,7 @@ public interface Question extends Query {
* Returns the question text that should be displayed to the user. This is localized
* to the {@link Language} and in line with the {@link Theme} set in the
* {@link AkiwrapperBuilder}.
* <h2>Example</h2> {@code Is your character real?}
* <h4>Example</h4> {@code Is your character real?}
*
* @return the question text.
*
Expand All @@ -135,7 +135,7 @@ default String getQuestion() {
* "attitude", and they represent Akinator's current confidence - previously this was
* calculated using a formula on the step and progression values, now it's returned
* by the API. On the website, the akitude is shown on the left of the question box.
* <h2>Example</h2>
* <h4>Example</h4>
* {@code https://en.akinator.com/assets/img/akitudes_670x1096/defi.png}
*
* @return the akitude image URL.
Expand Down

0 comments on commit afb1fe3

Please sign in to comment.