#312 Add index of checks

release_4.0
closed
Lars Kühne
5
2012-10-10
2004-08-11
Jay Dunning
No

It would be very helpful to have an alphabetical index
of checks.

Two use cases where this would be useful:

a) When reading a config file, trying to find the
documentation for a given check.

b) When looking for a particular check and it's not in
the expected category. (Example: Indentation, which I
always expect to find in Whitespace.)

I'm attaching a set of quick and dirty scripts I hacked
together to extract an index from the HTML
documentation on DOS using Tidy and Saxon. Unzip from
the root Checkstyle directory to create file
docs/checks_index.

(I had to use Tidy because the documentation HTML is
not valid.)

Discussion

  • Jay Dunning
    Jay Dunning
    2004-08-11

    Scripts to create a checks index on DOS using Tidy and Saxon.

     
  • Lars Kühne
    Lars Kühne
    2004-10-22

    Logged In: YES
    user_id=401384

    Working on this one now, almost done. It's easy to do in the
    doclet that generates docs from check implementation javadoc
    (see bug #760014).

     
  • Lars Kühne
    Lars Kühne
    2004-10-24

    Logged In: YES
    user_id=401384

    Done. Will be available in release 4.0 (but not the upcoming
    release 3.5)