Re: [Doxygen-develop] Spell checking

[Dimitri v. H. <do...@gm...>]

On 6/22/05, Michael McTernan <Mic...@tt...> wrote:
> Hi there,
>=20
> I'm starting to build up a bit of documentation using Doxygen, and realis=
e
> that I've made the odd spelling mistake.  It would help me if Doxygen wou=
ld
> check spellings while generating documentations and produce warnings.
>=20
> Checking the lists archives, I haven't found anything significant about
> spell checking in Doxygen.  Surely this has been considered before?
>=20
> I was thinking that it would be simple to make a DocVisitor that together
> with something like GNU aspell, could check all the observable text and
> produce warnings for misspelt words.
>=20
> Particularly this would be better than extracting the comments from the
> source, and then running a spell checker as things like \a words or \code
> blocks could automatically be skipped.
>=20
> Anyone have any comments on this?  If I made such a DocVisitor, would it =
be
> welcomed?

I like the idea of using the DocVisitor class in combination with a
user-specified
external tool. So please go ahead and implement this.=20

I think it would require two new string-type config options, i.e
something like:
SPELL_CHECKER_CMD  - command to execute, empty =3D> no spell checking
SPELL_CHECKER_LOG   - log file to write the results to.

The only issue I see is reporting proper line numbers/context info
along with the misspelt words.

Regards,
  Dimitri