Skip to content

Commit 0b0d1b3

Browse files
committed
javadoc fixes
1 parent 2b34b69 commit 0b0d1b3

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/main/java/net/codebox/homoglyph/HomoglyphBuilder.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,9 @@ public static Homoglyph build() throws IOException {
3535
/**
3636
* Parses the specified file and uses it to construct a populated Homoglyph object.
3737
*
38+
* @param path the path to a file containing a list of homoglyphs (see the bundled char_codes.txt
39+
* file for an example of the required format)
40+
*
3841
* @return a Homoglyph object populated using the contents of the specified file
3942
*
4043
* @throws IOException if the specified file cannot be read
@@ -46,6 +49,9 @@ public static Homoglyph build(final String path) throws IOException {
4649
/**
4750
* Consumes the supplied Reader and uses it to construct a populated Homoglyph object.
4851
*
52+
* @param reader a Reader object that provides access to homoglyph data (see the bundled
53+
* char_codes.txt file for an example of the required format)
54+
*
4955
* @return a Homoglyph object populated using the data returned by the Reader object
5056
*
5157
* @throws IOException if the specified Reader cannot be read

0 commit comments

Comments
 (0)