Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Pasdoc can use Aspell to check the spelling of your descriptions. Just run pasdoc with the CommandLine option --spell-check. The spell-checking will be done using the same language that you specified by --language command-line option (default: English).
Then pasdoc will
Write all the words that you mispelled to standard output, using warnings like
Warning: Word mispelled "foo"
In addition, in your generated documentation all your mispelled words will be displayed in some special way and you will be able to see suggestions for them. E.g. in HtmlOutput each mispelled word will be displayed using some special color, and when you move your mouse over this word, you will see a hint like "suggestions: …".
You can also use the CommandLine option --spell-check-ignore-words=IGNORE-WORDS-FILE-NAME where IGNORE-WORDS-FILE-NAME is a file that contains words (one word per line) that should be ignored (i.e. not checked).
See also: ToDoSpellChecking.
For backward compatibility, we also allow --aspell=LANGUAGE command-line option, where LANGUAGE is the aspell code of the language that you use in documentation. This allows you to use a different language for spell-checking than the language you use for output strings… which is not really useful in normal situations.
You can use empty value for the LANGUAGE, in which case the language used for spell-checking will be the same as set by the --language, and then it works the same as --spell-check option. Except it’s error-prone and ugly when using on the command-line. For example, the following three calls are equivalent and all cause the spell-checking in Polish language:
pasdoc --language pl.iso-8859-2 --aspell pl source_file.pas pasdoc --language pl.iso-8859-2 --aspell '' source_file.pas pasdoc --language pl.iso-8859-2 --aspell= source_file.pas
But you cannot use the (most natural) form
pasdoc --language pl.iso-8859-2 --aspell source_file.pas
because then source_file.pas is interpreted (and rejected) as language name.