No spell checking tool for C++ comments

[louis-langholtz]

Expected/Desired Behavior or Experience:

There should be no spelling mistakes in C++ comments especially since many of the comments are used in Doxygen documentation output. Need a command line tool for checking for spelling mistakes. This tool should be both manually and automatically runnable.

Actual Behavior:

There's currently no command line tool in place to check for spelling mistakes. Not manually nor automatically.

Steps to Reproduce the Actual Behavior:

Make a pull request with C++ code in it that has a comment with some words misspelled and notice that the misspellings don't get flagged by the PR mechanism.

[louis-langholtz]

Something like using LLVM/Clang to emit the C++ comments and then run that output through a normal spell checker.

For example the following emits the AST for the Math.hpp file:

clang++ --std=c++14 -I. -Xclang -ast-dump -fsyntax-only PlayRho/Common/Math.hpp

Or to output the same but without the special characters add in the -fno-diagnostics-color option as in:

clang++ --std=c++14 -I. -fno-diagnostics-color -Xclang -ast-dump -fsyntax-only PlayRho/Common/Math.hpp

But it only seems to emit the Doxygen comments. So maybe there's something along the lines of using the LLVM library for this.

[louis-langholtz]

Uploaded a new project I created for this: pyspellcode. It's a python script that parses the AST dump output from clang and runs words found in comment nodes through hunspell. It's not perfect by any means but it's completely IDE independent. It just needs clang and hunspell and a customized dictionary file for any extra words not already in hunspell's builtin dictionary.

I should be able to hook this up to this project's continuous integration at some point for automatically spell checking comments. Running it by hand for now though (to start with) and will be uploading a spell fix branch next.

[louis-langholtz]

Closing this since a tool for spell checking is available now.

Usage for this project is like:

 spell-check.py -I. -p Documentation/extra-words.dic -std=c++14 PlayRho/Dynamics/Body.hpp