diff --git a/src/main/java/io/codearte/jfairy/Fairy.java b/src/main/java/io/codearte/jfairy/Fairy.java index cc1196bf..7f6cfc51 100644 --- a/src/main/java/io/codearte/jfairy/Fairy.java +++ b/src/main/java/io/codearte/jfairy/Fairy.java @@ -83,6 +83,7 @@ public Person person(PersonProperties.PersonProperty... personProperties) { /** * Use this method to generate fake company * + * @param companyProperties desired company features * @return A {@link io.codearte.jfairy.producer.company.CompanyProvider} instance */ public Company company(CompanyProperties.CompanyProperty... companyProperties) { diff --git a/src/main/java/io/codearte/jfairy/producer/company/DefaultCompanyProvider.java b/src/main/java/io/codearte/jfairy/producer/company/DefaultCompanyProvider.java index 2c039195..e9e2fb74 100644 --- a/src/main/java/io/codearte/jfairy/producer/company/DefaultCompanyProvider.java +++ b/src/main/java/io/codearte/jfairy/producer/company/DefaultCompanyProvider.java @@ -60,7 +60,7 @@ public void generateName() { /** * In case of the illegal hostname characters in company name - * and truncate it if it is too long (length > 10) after escape + * and truncate it if it is too long (length > 10) after escape * * It is compatible with other non-latin language and will not change the original result for latin language. * diff --git a/src/main/java/io/codearte/jfairy/producer/net/NetworkProducer.java b/src/main/java/io/codearte/jfairy/producer/net/NetworkProducer.java index f7f8510c..1d5c43f5 100644 --- a/src/main/java/io/codearte/jfairy/producer/net/NetworkProducer.java +++ b/src/main/java/io/codearte/jfairy/producer/net/NetworkProducer.java @@ -22,7 +22,8 @@ public String ipAddress() { * Add a simple url generator * Example: networkProducer.url(baseProducer.trueOrFalse()) * - * @return + * @param isHttps is https or not + * @return A faked url. */ public String url(boolean isHttps) { String mergedIP = ipAddress().replaceAll("\\.", ""); diff --git a/src/main/java/io/codearte/jfairy/producer/util/ZhFairyUtil.java b/src/main/java/io/codearte/jfairy/producer/util/ZhFairyUtil.java index bb12405c..b25f28f2 100644 --- a/src/main/java/io/codearte/jfairy/producer/util/ZhFairyUtil.java +++ b/src/main/java/io/codearte/jfairy/producer/util/ZhFairyUtil.java @@ -65,9 +65,10 @@ private ZhFairyUtil() {} /** * Get random number from 1 to max in 0 leading string format. + * @param baseProducer BaseProducer * @param max upper bound of number * @param paddingSize padding size - * @return + * @return A number smaller than #max with #paddingSize digits in string format */ public static String getRandomNumStr(BaseProducer baseProducer, int max, int paddingSize) { int rndNum = baseProducer.randomBetween(1, max);