com.puppycrawl.tools.checkstyle.gui.package-info Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation

Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard

There is a newer version: 10.18.1

////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2016 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
////////////////////////////////////////////////////////////////////////////////

/**
 * User interface classes for CheckStyle. Currently this is mainly a gui to aid
 * Check developers.
 *
 * This is definitely work in progress. Here are some ideas where
 * you could help:
 * 

 *   
 *     Add a read only editor field that highlights the selected AST node.
 *   
 *   
 *     Clicking in the editor field could open the corresponding tree path.
 *   
 *   
 *     Add a configuration GUI that can be used in all IDE plugins
 *     (well, err.., except Eclipse).
 *   
 *   
 *     Add ability to execute individual Checks and display the error messages.
 *   
 *   
 *     Add a GUI for the
 *     {@link com.puppycrawl.tools.checkstyle.api.FileContents}.
 *   
 *   
 *     Add ability to define a Check by example (another one of those crazy
 *     ideas... :-)
 *   
 * 
 */
package com.puppycrawl.tools.checkstyle.gui;