Fixed javadoc (issue #164)

This commit is contained in:
andsel
2017-01-04 12:52:42 +01:00
parent 480e36579c
commit 12a3c65c9b
15 changed files with 98 additions and 22 deletions
@@ -24,7 +24,7 @@ import java.text.ParseException;
/**
* Parses the acl configuration file.
* If a line starts with # it's comment.
* Blank lines are skipped. The format is "topic [read|write|readwrite] <topic name>"
* Blank lines are skipped. The format is "topic [read|write|readwrite] {topic name}"
*
* @author andrea
* */
@@ -33,6 +33,9 @@ public class ACLFileParser {
/**
* Parse the configuration from file.
* @param file to parse
* @return the collector of authorizations form reader passed into.
* @throws ParseException if the format is not compliant.
*/
public static AuthorizationsCollector parse(File file) throws ParseException {
if (file == null) {
@@ -54,8 +57,9 @@ public class ACLFileParser {
/**
* Parse the ACL configuration file
*
* @throws java.text.ParseException if the format is not compliant.
* @param reader to parse
* @return the collector of authorizations form reader passed into.
* @throws ParseException if the format is not compliant.
*/
public static AuthorizationsCollector parse(Reader reader) throws ParseException {
if (reader == null) {
@@ -19,7 +19,7 @@ import io.moquette.server.config.FileResourceLoader;
/**
* Load user credentials from a text file.
* Each line of the file is formatted as "<username>:<sha256(password)>". The username mustn't contains : char.
* Each line of the file is formatted as "[username]:[sha256(password)]". The username mustn't contains : char.
*
* To encode your password from command line on Linux systems, you could use:
* <pre>
@@ -33,7 +33,7 @@ import java.util.Map;
/**
* Load user credentials from a text resource.
* Each line of the file is formatted as "<username>:<sha256(password)>". The username mustn't contains : char.
* Each line of the file is formatted as "[username]:[sha256(password)]". The username mustn't contains : char.
*
* To encode your password from command line on Linux systems, you could use:
* <pre>