Fixed missing missing images in Eiffel Inspector documentation.

git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@1798 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eiffel-org
2017-03-22 21:20:05 +00:00
parent 375dde3803
commit 19aa616ea5
22 changed files with 34 additions and 11 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

View File

@@ -0,0 +1,2 @@
title=CA Analysis Buttons
path=content/CA_Analysis_Buttons.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -0,0 +1,2 @@
title=CA Class Context Menu
path=content/CA_Class_Context_Menu.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

View File

@@ -0,0 +1,2 @@
title=CA Cluster Context Menu
path=content/CA_Cluster_Context_Menu.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.1 KiB

View File

@@ -0,0 +1,2 @@
title=CA Fixing Rule Violation
path=content/CA_Fixing.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1,2 @@
title=CA Preference Dialog
path=content/CA_Preferences_Dialog.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

View File

@@ -0,0 +1,2 @@
title=CA Rule Preferences
path=content/CA_Rule_Preferences.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

View File

@@ -0,0 +1,2 @@
title=CA Simple Analysis
path=content/CA_Sample_Results.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

View File

@@ -0,0 +1,2 @@
title=Eiffel Inspector - Tool Panel
path=content/Ca_empty-tool-panel.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

View File

@@ -0,0 +1,2 @@
title=Eiffel Inspector Command Line
path=content/Eiffel_Inspector-command_line_0.png

View File

@@ -5,7 +5,8 @@
= Sorting and Filtering =
The list of rule violations can be sorted by any column by clicking on its header. Click it again to switch the sorting direction. You can hide and show errors, warnings, suggestions, and hints by clicking the corresponding toggle buttons in the middle of the toolbar. Typing in the text field on the right side of the panel toolbar filters the results. The filter takes into consideration the title, the ID, the affected class, and the description of the rule. It is a live filter that filters while you are typing. Press the button on the right of the text field to clear the filter and display again all violations.
[img_assist|nid=2645|title=The results of code analysis as a list of rule violations (example)|desc=|link=node|align=center|width=978|height=361]
[[Image:CA Simple Analysis|center|978px|The Results of code analysis as a list of rule violations (example)]]
= Navigating Through the Results =
@@ -13,7 +14,8 @@ In the list of rule violations, formatted elements like classes and features are
= Fixing Rule Violations =
[img_assist|nid=2654|title=Fixing a rule violation.|desc=|link=node|align=center|width=484|height=79]
[[Image:CA Fixing Rule Violation|center|484px|Fixing a rule violation.]]
Some violations provide automatic fixing. Right-clicking the corresponding row in the tool panel opens a context menu where you can choose from one or more possible fixes. When you click on ''Fix: ...'' the source code will be adapted and the project will be recompiled.

View File

@@ -6,13 +6,13 @@
The ''Preferences'' button in the toolbar opens a dialog containing all preferences for the Eiffel Inspector. There you can enable and disable all rules of a certain severity, you can choose colors for the results, and there are many preferences that control the behavior of individual rules.
[img_assist|nid=2651|title=Preferences|desc=|link=node|align=center|width=640|height=460]
[[Image:CA Preference Dialog|center|640px|Preferences]]
= Rule-specific Preferences =
The rule-specific preferences are located in the ''Rules'' subfolder. Two preferences can be found for every rule: ''Enabled/disabled'' and the ''severity score''. Some rules have additional integer or boolean preferences like thresholds.
[img_assist|nid=2652|title=Rule-specific Preferences|desc=|link=node|align=center|width=572|height=268]
[[Image:CA Rule Preferences|center|572px|Rule-specific Preferences]]
= Exporting and Importing Preference Profiles =

View File

@@ -5,13 +5,16 @@
==Eiffel Inspector Tool==
After opening an existing project with EiffelStudio, go to View->Tools->Eiffel Inspector to show the tool. It will look like this:
[img_assist|nid=2643|title=Eiffel Inspector - Tool Panel|desc=The Inspector Eiffel tool panel before the analysis.|link=node|align=center|width=1119|height=324]
[[Image:Eiffel Inspector - Tool Panel|center|1119px|Eiffel Inspector - Tool Panel]]
The Inspector Eiffel tool panel before the analysis.
== A Simple Analysis ==
Press the '''Analyze System''' button. If needed, the system will be compiled now. A successful compilation is required for the Eiffel Inspector to run. After a successful compilation the analysis will start and will check all classes of your system. The status bar shows the progress by displaying the class currently being analyzed. As soon as the analysis is complete, results will show up in the panel as a list of ''rule violations''.
[img_assist|nid=2645|title=Eiffel Inspector - Simple Analysis|desc=The results of code analysis as a list of rule violations (example).|link=node|align=center|width=978|height=361]
[[Image:CA Simple Analysis|center|978px|Eiffel Inspector - Simple Analysis]]
The results of code analysis as a list of rule violations (example).
A double-click on a row will update the EiffelStudio editor to go to the position in the code where the issue lies. You may expand the row to see more details.

View File

@@ -14,25 +14,25 @@ There are two ways of running the Eiffel Inspector
== Analyzing the System ==
If you want to analyze the whole system of the currently open project press the '''Analyze System''' button in the toolbar. Every compiled classes of the system will be analyzed.
[img_assist|nid=2647|title=Analyze System|desc=|link=node|align=center|width=368|height=84]
[[Image:CA Analysis Buttons|center|368px|Analyze System]]
== Analyzing a Class or Group ==
=== Current Class ===
Left-clicking the '''Analyze Item''' button in the toolbar will start an analysis of the class that is currently opened in the editor.
[img_assist|nid=2647|title=Analyze Item|desc=|link=node|align=center|width=368|height=84]
[[Image:CA Analysis Buttons|center|368px|Analyze Item]]
=== Any Class ===
There are two ways of analyzing an arbitrary class (either from your system or from a library):
* Right-click on a class name and select '''Run Eiffel Inspector on Class...''' from the context menu:
[img_assist|nid=2648|title=Class Context Menu|desc=|link=node|align=center|width=371|height=487]
[[Image:CA Class Context Menu|center|371px|Class Context Menu]]
* Pick a class and drop it on the '''Analyze Item''' button.
=== Clusters ===
To analyze a cluster there are two possibilities, like for classes:
* You can either right-click the cluster and select '''Run Eiffel Inspector on cluster''' from the context menu:
[img_assist|nid=2649|title=Cluster Context Menu|desc=|link=node|align=center|width=247|height=220]
[[Image:CA Cluster Context Menu|center|247px|Cluster Context Menu]]
* Pick a cluster and drop it on the '''Analyze Item''' button.
=== Others ===
@@ -58,7 +58,7 @@ Upon a successful compilation either the whole system or the classes mentioned i
As soon as everything needed has been analyzed the results will be displayed as a list of rule violations. These rule violations are sorted by class and by location. In addition to the name of the violated rule and the rule ID, a description of the concrete violation will be displayed as well.
[img_assist|nid=2677|title=Eiffel Inspector - Command Line|desc=|link=node|align=center|width=877|height=691]
[[Image:Eiffel Inspector Command Line|center|877px|Eiffel Inspector - Command Line]]
=== Output to file ===