Add missing documentation

This commit is contained in:
Davide De Rosa 2019-03-25 15:46:15 +01:00
parent 9c4d491a3b
commit 53f3048674
1 changed files with 1 additions and 1 deletions

View File

@ -127,7 +127,7 @@ public class ConfigurationParser {
Parses an .ovpn file as an array of lines. Parses an .ovpn file as an array of lines.
- Parameter lines: The array of lines holding the configuration. - Parameter lines: The array of lines holding the configuration.
- Parameter url: The optional URL of the configuration file. - Parameter originalURL: The optional original URL of the configuration file.
- Parameter returnsStripped: When `true`, stores the stripped file into `ParsingResult.strippedLines`. Defaults to `false`. - Parameter returnsStripped: When `true`, stores the stripped file into `ParsingResult.strippedLines`. Defaults to `false`.
- Returns: The `ParsingResult` outcome of the parsing. - Returns: The `ParsingResult` outcome of the parsing.
- Throws: `ParsingError` if the configuration file is wrong or incomplete. - Throws: `ParsingError` if the configuration file is wrong or incomplete.