ITK Procedure for Checking Style: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
 
(7 intermediate revisions by 6 users not shown)
Line 1: Line 1:
= Get KWStyle =
#REDIRECT [[ITK/Release_4/Coding_Style/KWStyle]]
 
* The Home Page of KWStyle is at http://public.kitware.com/KWStyle/
 
== Downloading KWStyle ==
 
 
* Download KWStyle from http://public.kitware.com/KWStyle/download.htm
 
== Building KWStyle ==
 
* Configure with CMake
* Build with your compiler
 
= Configure your ITK Build =
 
* Rerun CMake on you ITK Binary builds
 
== Point to your KWStyle executable ==
 
* Provide the path to your KWStyle executable
 
== Select error format ==
 
* The options are
** Formatting for VIM (the best editor)
** Formatting for Visual Studio (if you are a Windows victim)
 
= Running KWStyle =
 
== From the command line ==
 
Use the following command
 
  KWStyle -v  -xml  ITK_DIR/ITK.kws.xml    filename
 
Where
 
* -v : stands for Verbose
* -xml : is the file containing the description of the coding style in XML
* ITK_DIR : should be replaced with the path to the binary directory where you build ITK
* filename : is the name of the file for which you are currently checking coding style

Latest revision as of 15:41, 28 August 2013