RE: [Doxygen-develop] Spell checking

[Michael M. <Mic...@tt...>]

Hi,

What I had in mind was using a DocVisitor to dump a file of the words (with
some file/line information) that should be spell checked.  This can then be
checked with something like aspell, perhaps using a small bit of script to
manage the error reporting etc...  Any other spelling tool could be used;
that's not for Doxygen to worry about :)

I think that this should not affect Doxygen very much at all, but has the
advantage of generating documents and spell checking in one step, while also
being sensitive to Doxygen mark-up, and as you say, removing symbols and the
like.

Cheers,

Mike

> -----Original Message-----
> From: dox...@li... [mailto:doxygen-develop-
> ad...@li...] On Behalf Of Stefan Kost
> Sent: 24 June 2005 12:53
> To: Michael McTernan
> Cc: dox...@li...
> Subject: Re: [Doxygen-develop] Spell checking
> 
> hi hi,
> aspell already has a c/c++ comment mode. One idea for improvment I have
> for that
> is to filter the wors against the TAGS database before spell-checking.
> This
> would get dis of all the warning regarding mispelled words which are in
> fact
> symbols (function names etc.).
> 
> Stefan
> 
> Michael McTernan wrote:
> > Hi there,
> >
> > I'm starting to build up a bit of documentation using Doxygen, and
> realise
> > that I've made the odd spelling mistake.  It would help me if Doxygen
> would
> > check spellings while generating documentations and produce warnings.
> >
> > Checking the lists archives, I haven't found anything significant about
> > spell checking in Doxygen.  Surely this has been considered before?
> >
> > 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.
> >
> > 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.
> >
> > Anyone have any comments on this?  If I made such a DocVisitor, would it
> be
> > welcomed?
> >
> > Cheers,
> >
> > Mike
> >
> >
> >
> > -------------------------------------------------------
> > SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
> > from IBM. Find simple to follow Roadmaps, straightforward articles,
> > informative Webcasts and more! Get everything you need to get up to
> > speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
> > _______________________________________________
> > Doxygen-develop mailing list
> > Dox...@li...
> > https://lists.sourceforge.net/lists/listinfo/doxygen-develop
> >
> 
> --
>       \|/            Stefan Kost
>      <@ @>           private            business
> +-oOO-(_)-OOo------------------------------------------------------ - - -
> -   -
> |       __  Address  Simildenstr. 5     HTWK Leipzig, Fb IMN, Postfach
> 301166
> |      ///           04277 Leipzig      04251 Leipzig
> | __  ///            Germany            Germany
> | \\\///    Phone    +49341 2253538     +49341 30766101
> |  \__/     EMail    st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de
> |           WWW      www.sonicpulse.de  www.imn.htwk-
> leipzig.de/~kost/about.html
> ===-=-=--=---=---------------------------------- - - -  -    -