Configuration XML

Configuration XML

<ctags_path>

By default IncludeChecker uses the ctags.exe that resides in the bin directory next to IncludeChecker.exe. Use the <ctags_path> element to specify a ctags.exe in a different location.

<include_path>

For IncludeChecker to be able to find header files, include paths need to be specified using one or more <include_path> elements. The list of includes should exactly match the list used by the compiler.

<interface_header>

Use the <interface_header> element to mark a specific header as an interface header.

<exclude_path>

Source files and header files that reside within an exclude path are not checked. Use this to filter out portions of a source tree, for example third party sources.

<type_alias_prefix>

Use this element to a add a prefix for type aliases.

<type_alias_suffix>

Use this element to a add a suffix for type aliases.

<verbose>

If the <verbose> element is present, IncludeChecker will display which tags it finds from each header.

<ignore_header>

Sub-elements: <source> (optional), <header>
With the <ignore_header> element trouble-some source files or headers can be ignored. If no <source> sub-element is specified, the specified header will always be ignored. Otherwise it will only be ignored when used from the specified source file.

Example XML

~~~~~~~~
<devpal>
<includechecker>
<settings>

  <!-- By default IncludeChecker will use the ctags.exe from the ctags
       directory next to IncludeChecker.exe.
       You can specify an other path if you want to use a different ctags.exe
       or want to put it in a different directory. -->
  <!--
  <ctags_path>c:\my_ctags\ctags.exe<ctags_path>
  -->

  <!-- Include paths are needed to find .h files. This will typically be the
       same list that is used by the sources that are being checked. -->
  <include_path>c:\Program Files (x86)\Microsoft Visual Studio 10.0\VC\include</include_path>
  <!-- On 32-bit Windows you need to remove " (x86)" from the
       Program Files path. -->

  <!-- Define type alias prefixes, see complex.cpp. -->
  <type_alias_prefix>c</type_alias_prefix>
  <type_alias_prefix>p</type_alias_prefix>
  <type_alias_prefix>r</type_alias_prefix>
  <type_alias_prefix>rc</type_alias_prefix>

  <!-- Define type alias suffixes, see Car.h. -->
  <type_alias_suffix>Quad</type_alias_suffix>

  <ignore_header>
    <!-- Always ignore pragmas.h, because it does not contain any
         declarations. See all cpp files. -->
    <header>pragmas.h</header>

    <!-- It's possible to add a source element:
    <source>somesource.cpp</source>
         which means that the header will only be ignored for that one
         source file. -->
  </ignore_header>

  <!-- Headers that are to be processed as interface headers (which means
       that they don't actually declare anything, but include other headers
       that do). See CarFactory.cpp. -->
  <interface_header>Cars.h</interface_header>
</settings>

</includechecker>
</devpal>
~~~~~~~~~