object SpellCheck extends Error
The SpellCheck object is used to check the spelling in source code comments.
If not using Linux, may need to replace path for 'DICTIONARY'.
Note, okay to use '/' since the dictionary location is system-dependent anyway.
- Alphabetic
- By Inheritance
- SpellCheck
- Error
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
def
checkDir(dir_name: String, checkAll: Boolean = false): Unit
Check the spelling of comments in files within the given directory.
Check the spelling of comments in files within the given directory.
- dir_name
the directory name
- checkAll
whether to check whole files or just the comments
-
def
checkFile(file_name: String, checkAll: Boolean = false): Unit
Check the spelling of comments in the given file.
Check the spelling of comments in the given file. Toggle commented out lines below to check // ... EOL or not.
- file_name
the file name
- checkAll
whether to check the whole file or just the comments
-
def
checkLine(line: String, lineNo: Int): Unit
Check the spelling of words in the given line.
Check the spelling of words in the given line.
- line
the line to check
- lineNo
the line number of the line
-
final
def
flaw(method: String, message: String): Unit
Show the flaw by printing the error message.
Show the flaw by printing the error message.
- method
the method where the error occurred
- message
the error message
- Definition Classes
- Error