Includator Usage

This section of the Includator help shows how a programmer can make use of the include structure optimization algorithms provided by the Includator plug-in. The description includes information on how to trigger an Includator algorithm and on how the outcome is presented to the user.

Use the following links for a detailed description of a concrete Includator feature. Note that these descriptions are more detailed than the ones found in the sidebar of www.includator.com.

Running an Includator Algorithm

An Includator algorithm can be started in two different places. Either through the main menu-bar entry, which is visible when the C++ perspective is active.

Or through the pop-up menu accompanying a source or header file or a C++ project in either the C++ Explorer, the Project Explorer or the Navigator Eclipse view.

As can be seen in the sample screenshot, some of the algorithms can not be started on a project. These can only be triggered if the focus is either on a source or header file in the C++ Explorer, Project Explorer or Navigator, or inside of an open C++ editor.

Visualization of Includator Suggestions

As already mentioned, Includator algorithms produce suggestions that provide information on the given code. These suggestions will be visualized either in the Includator suggestion dialog or they will be shown in the C++ editor in the form of markers or annotations.

Includator Suggestion Dialog

The Includator suggestion dialog will show up with almost all algorithms, but only if the Show Analysis Result in Dialog checkbox menu entry is enabled. Note that this checkbox menu entry is only available through the main menu-bar entry (first screenshot above).

The Includator suggestion dialog will not show up when running Static Code Coverage or Auto Organize Includes.

In the suggestion dialog one can choose how to proceed. There are options to apply to all the suggestions or only to those that are checked in the suggestion tree on the left side.

Includator Suggestion Markers

Includator suggestion makers show up in the editor as normal markers with one of Includator's icons.

Includator Annotations

Annotations are added to the editor when running Static Code Coverage on a C++ project.

Applying Proposed Suggestion Solutions

Almost all of the Includator suggestions bring along solution proposals (called QuickFix) which can be applied on a given document to resolve the issue. These solution proposals will be shown by clicking on an Includator suggestion marker or by putting the cursor on a line containing a marker an clicking ctrl+1.

After applying a quickfix on a document, the document will be adapted according to the current suggestion and the marker will be removed.

Deleting Includator Markers

There are two ways to get rid of Includator's editor markers (without applying them). To delete one or several specific markers one can use the the Problems view of Eclipse.

To delete all Includator markers, choose Remove all Static Analysis Markers from the Includator menu.
In addition it is also possible to remove all static code coverage annotations from a project.