Skip to content

Commit

Permalink
docs: add reference field to Doc annotation.
Browse files Browse the repository at this point in the history
  • Loading branch information
ashigeru committed Feb 14, 2024
1 parent 2163b5b commit c516d10
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions modules/common/src/main/java/com/tsurugidb/tsubakuro/util/Doc.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,18 @@
* @return additional notes for the target element
*/
String[] note() default {};


/**
* Optional references for the target element.
* <p>
* Any of following notations is allowed:
* </p>
* <ul>
* <li> <code>https://...</code> </li>
* <li> <code>page-title&#64;https://...</code> </li>
* </ul>
* @return optional references for the target element.
*/
String[] reference() default {};
}

0 comments on commit c516d10

Please sign in to comment.