mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-07 15:22:31 +01:00
Author:halw
Date:2008-09-26T17:52:50.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@50 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
@@ -3,6 +3,6 @@
|
|||||||
[[Property:uuid|5ea97cae-9001-7d9d-2dbb-2b632b05fb75]]
|
[[Property:uuid|5ea97cae-9001-7d9d-2dbb-2b632b05fb75]]
|
||||||
There are many ways to find a feature in a class. In particular :
|
There are many ways to find a feature in a class. In particular :
|
||||||
* You can use the [[Feature tool|feature tool]] and search the tree by expanding feature clauses. This tool, however, displays only the features that are defined or redefined in the current class text. If you do not know if the feature is inherited or not, you may therefore not find what you are looking for with this method.
|
* You can use the [[Feature tool|feature tool]] and search the tree by expanding feature clauses. This tool, however, displays only the features that are defined or redefined in the current class text. If you do not know if the feature is inherited or not, you may therefore not find what you are looking for with this method.
|
||||||
* You can also use the [[Class formatters: Introduction|class tab]] in the context tool. It will allow you to see all the [[Attributes| attributes]] or [[Routines|routines]] , or all the [[Exported features|public features]] for instance. If you do not know if the feature you seek is an attributes or a function and if it is public, this may not be the right method either.
|
* You can also use the [[Class views|class tab]] in the context tool. It will allow you to see all the [[Attributes| attributes]] or [[Routines|routines]] , or all the [[Exported features|public features]] for instance. If you do not know if the feature you seek is an attributes or a function and if it is public, this may not be the right method either.
|
||||||
* If you know the name or a part of the name of the feature you are looking for, the easier and faster way will probably be to use the [[Main address bar|address bar]] . If you type this name in the feature field of the bar (using "*" and "?" wildcards if you want to), the editor will be centered on the right class if necessary (i.e. if the feature is inherited) and scroll to the position of the text of the feature.
|
* If you know the name or a part of the name of the feature you are looking for, the easier and faster way will probably be to use the [[Main address bar|address bar]] . If you type this name in the feature field of the bar (using "*" and "?" wildcards if you want to), the editor will be centered on the right class if necessary (i.e. if the feature is inherited) and scroll to the position of the text of the feature.
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Click on '''save and exit''' to complete the change.
|
|||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Preference window overview|Preference window description]] <br/>
|
[[Preference window overview|Preference window description]] <br/>
|
||||||
[[EiffelStudio preferences: Introduction|Preferences reference]] }}
|
[[EiffelStudio preferences]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
[[Property:title|Changing texts display]]
|
[[Property:title|Changing texts display]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|b7c1cbac-975b-c6e6-050b-e48b61732a57]]
|
[[Property:uuid|b7c1cbac-975b-c6e6-050b-e48b61732a57]]
|
||||||
By modifying EiffelStudio [[EiffelStudio preferences: Introduction|preferences]] , you can change the font and the colors used to display texts in the editor. For more information, refer to EiffelStudio [[Interface|graphical preferences reference]] .
|
By modifying [[EiffelStudio preferences]], you can change the font and the colors used to display texts in the editor. For more information, refer to EiffelStudio [[Interface|graphical preferences reference]] .
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Customizing class text views|Customizing formatted output]] }}
|
[[Customizing class text views|Customizing formatted output]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -2,13 +2,13 @@
|
|||||||
[[Property:weight|5]]
|
[[Property:weight|5]]
|
||||||
[[Property:uuid|18dcc14f-2ad0-3f3b-4b2e-fc9251035b6f]]
|
[[Property:uuid|18dcc14f-2ad0-3f3b-4b2e-fc9251035b6f]]
|
||||||
Every class in your system inherits from <eiffel>ANY</eiffel>. <eiffel>INTEGER</eiffel>, like other classes that represent basic types, is very often a supplier of the classes the user wrote. It may therefore not be interesting to display classes such as <eiffel>ANY</eiffel> or <eiffel>INTEGER</eiffel> in [[Diagram tool: Introduction|BON diagrams]] .
|
Every class in your system inherits from <eiffel>ANY</eiffel>. <eiffel>INTEGER</eiffel>, like other classes that represent basic types, is very often a supplier of the classes the user wrote. It may therefore not be interesting to display classes such as <eiffel>ANY</eiffel> or <eiffel>INTEGER</eiffel> in [[Diagram tool: Introduction|BON diagrams]] .
|
||||||
EiffelStudio allows you to customize a list of classes that it has to ignore when it creates diagrams. This list is stored in the [[EiffelStudio preferences: Introduction|preferences]] . To modify it, first open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category of the "Tools" category in the preferences tree. On the right, you will then see a table of preferences, which includes "Show ALL classes in the diagram" and "Names of classes that should not appear in generated diagrams". If "Show ALL classes in the diagram" is not False, click on it and set it to False. Then click on "Names of classes that should not appear in generated diagrams" and edit the list. Class names must be separated by semicolons.
|
EiffelStudio allows you to customize a list of classes that it has to ignore when it creates diagrams. This list is stored in the [[EiffelStudio preferences]] . To modify it, first open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category of the "Tools" category in the preferences tree. On the right, you will then see a table of preferences, which includes "Show ALL classes in the diagram" and "Names of classes that should not appear in generated diagrams". If "Show ALL classes in the diagram" is not False, click on it and set it to False. Then click on "Names of classes that should not appear in generated diagrams" and edit the list. Class names must be separated by semicolons.
|
||||||
|
|
||||||
After modifying the list, click on '''save and exit''' to complete the change.
|
After modifying the list, click on '''save and exit''' to complete the change.
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Preference window overview|Preference window description]] <br/>
|
[[Preference window overview|Preference window description]] <br/>
|
||||||
[[EiffelStudio preferences: Introduction|Preferences reference]] }}
|
[[EiffelStudio preferences]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ After modifying the command line, click on '''save and exit''' to complete the c
|
|||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Preferences Reference|Preference window description]] <br/>
|
[[Preferences Reference|Preference window description]] <br/>
|
||||||
[[EiffelStudio preferences: Introduction|Preferences reference]] }}
|
[[EiffelStudio preferences]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,17 +1,17 @@
|
|||||||
[[Property:title|Customizing class text views]]
|
[[Property:title|Customizing class text views]]
|
||||||
[[Property:weight|6]]
|
[[Property:weight|6]]
|
||||||
[[Property:uuid|386c40f1-3427-cf1c-1043-46aeac1bc3c5]]
|
[[Property:uuid|386c40f1-3427-cf1c-1043-46aeac1bc3c5]]
|
||||||
It is possible in EiffelStudio to customize some properties of [[Formatters: Introduction|class text views]] (other than basic texts) displayed in the editor or class and feature tabs of the context tool. Besides [[Changing texts display|graphical appearance]] , you may modify:
|
It is possible in EiffelStudio to customize some properties of [[Formatted information about compiled classes and features|class text views]] (other than basic texts) displayed in the editor or class and feature tabs of the context tool. Besides [[Changing texts display|graphical appearance]], you may modify:
|
||||||
* the order of feature clauses.
|
* the order of feature clauses.
|
||||||
* the type of callers and suppliers displayed in the corresponding views.
|
* the type of callers and suppliers displayed in the corresponding views.
|
||||||
* the views that are selected by default.
|
* the views that are selected by default.
|
||||||
* the indexing clauses that should not be displayed.
|
* the indexing clauses that should not be displayed.
|
||||||
These properties are set in the [[EiffelStudio preferences: Introduction|preferences]] . You can modify them in the [[Preference window overview|preferences window]] . To open this window, select '''Preferences...''' in the '''Tool''' menu. Then select the "Context tool" sub-category of the "Tools" category in the preferences tree. Click then on a preference on the right to modify its value.
|
These properties are set in the [[EiffelStudio preferences]]. You can modify them in the [[Preference window overview|preferences window]]. To open this window, select '''Preferences...''' in the '''Tool''' menu. Then select the "Context tool" sub-category of the "Tools" category in the preferences tree. Click then on a preference on the right to modify its value.
|
||||||
Click on '''save and exit''' to complete the changes.
|
Click on '''save and exit''' to complete the changes.
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Preference window overview|Preference window description]] <br/>
|
[[Preference window overview|Preference window description]] <br/>
|
||||||
[[EiffelStudio preferences: Introduction|Preferences reference]] }}
|
[[EiffelStudio preferences]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,12 +4,12 @@
|
|||||||
By default, [[EiffelStudio Editor Introduction|the editor]] and the [[EiffelStudio window overview|context tool]] are [[Centering tools on a component|centered]] on the same cluster, class or feature. It is possible to make the context tool independent from the editor. It has then its own address bar and can display information on a totally different component than the one on which the editor is centered.
|
By default, [[EiffelStudio Editor Introduction|the editor]] and the [[EiffelStudio window overview|context tool]] are [[Centering tools on a component|centered]] on the same cluster, class or feature. It is possible to make the context tool independent from the editor. It has then its own address bar and can display information on a totally different component than the one on which the editor is centered.
|
||||||
To do so, click on or select '''Isolate context tool''' in the '''View''' menu. To go back to the previous configuration, click on the same icon again or select '''Merge context tool''' in the '''View''' menu.
|
To do so, click on or select '''Isolate context tool''' in the '''View''' menu. To go back to the previous configuration, click on the same icon again or select '''Merge context tool''' in the '''View''' menu.
|
||||||
|
|
||||||
You can also modify the [[EiffelStudio preferences: Introduction|preferences]] so that next time a window is opened, its context tool will be automatically independent: open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category in the "Tools" of the preferences tree. Lastly click on "Share addresses between the editor and the context tool" and set it to '''False'''. <br/>
|
You can also modify the [[EiffelStudio preferences]] so that next time a window is opened, its context tool will be automatically independent: open the [[Preference window overview|preferences window]] by choosing '''Preferences...''' in the '''Tools''' menu. Select then the "context tool" sub-category in the "Tools" of the preferences tree. Lastly click on "Share addresses between the editor and the context tool" and set it to '''False'''. <br/>
|
||||||
Click on save and exit to complete the change.
|
Click on save and exit to complete the change.
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Preference window overview|Preference window description]] <br/>
|
[[Preference window overview]] <br/>
|
||||||
[[EiffelStudio preferences: Introduction|Preferences reference]] }}
|
[[EiffelStudio preferences]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|f9b79d1c-6ca7-d0a3-1374-e71a8b450644]]
|
[[Property:uuid|f9b79d1c-6ca7-d0a3-1374-e71a8b450644]]
|
||||||
To create a new feature just [[Creating client/supplier links|add a new client link]] in the diagram.
|
To create a new feature just [[Creating client/supplier links|add a new client link]] in the diagram.
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Adding a feature: Introduction|Creating a new feature]] }}
|
[[Adding a feature]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Creating client/supplier links|Creating client/supplier links]] <br/>
|
[[Creating client/supplier links|Creating client/supplier links]] <br/>
|
||||||
[[Creating inheritance links|Creating Inheritance links]] <br/>
|
[[Creating inheritance links|Creating Inheritance links]] <br/>
|
||||||
[[New feature dialog: Introduction|Feature wizard]] }}
|
[[New feature dialog]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -9,8 +9,7 @@
|
|||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Creating aggregate client/supplier links|Creating aggregate client/supplier links]] <br/>
|
[[Creating aggregate client/supplier links|Creating aggregate client/supplier links]] <br/>
|
||||||
[[Creating inheritance links|Creating Inheritance links]] <br/>
|
[[Creating inheritance links|Creating Inheritance links]] <br/>
|
||||||
[[New feature dialog: Introduction|Feature wizard]] }}
|
[[New feature dialog]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,10 @@
|
|||||||
[[Property:title|Adding a class]]
|
[[Property:title|Adding a class]]
|
||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|592f9c3a-4533-d849-a0d7-5c00864e5c26]]
|
[[Property:uuid|592f9c3a-4533-d849-a0d7-5c00864e5c26]]
|
||||||
A dialog window is dedicated to the creation of new classes.
|
A dialog window is dedicated to the creation of new classes. <br/>
|
||||||
[[Image:new-class-dialog]]
|
[[Image:new-class-dialog]] <br/>
|
||||||
A list of all the clusters of the system lets you to choose in which one the new class will be inserted. The name of the new class and the name of the corresponding file can be set thank to two text fields above the list. It is also possible to define whether the class should be deferred or expanded, what its creation feature is (if any), what its parents are and whether the default feature clauses should be generated.
|
A list of all the clusters of the system lets you to choose in which one the new class will be inserted. The name of the new class and the name of the corresponding file can be set thank to two text fields above the list. It is also possible to define whether the class should be deferred or expanded, what its creation feature is (if any), what its parents are and whether the default feature clauses should be generated.
|
||||||
{{tip|You can change the class text that is generated by default by editing the following files:$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\full.cls (with default feature clauses) and ...\empty.cls (without default feature clauses). }}
|
{{tip|You can change the class text that is generated by default by editing the following files:$ISE_EIFFEL\studio\help\defaults\$ISE_PLATFORM\full.cls (with default feature clauses) and ...\empty.cls (without default feature clauses). }}<br/>
|
||||||
To make the window appear, you can:
|
To make the window appear, you can:
|
||||||
* Click [[Image:16x16--new-class-icon]] in the [[Main toolbars|standard toolbar]] .
|
* Click [[Image:16x16--new-class-icon]] in the [[Main toolbars|standard toolbar]] .
|
||||||
* Select '''New class''' in the '''Tools''' menu.
|
* Select '''New class''' in the '''Tools''' menu.
|
||||||
|
|||||||
@@ -1,5 +1,5 @@
|
|||||||
[[Property:title|Adding a feature]]
|
[[Property:title|Adding a feature]]
|
||||||
[[Property:weight|3]]
|
[[Property:weight|3]]
|
||||||
[[Property:uuid|c65b3fd0-05fb-9b16-79b9-d4207bf42769]]
|
[[Property:uuid|c65b3fd0-05fb-9b16-79b9-d4207bf42769]]
|
||||||
|
To add a feature to a class, you can directly edit its text of course. EiffelStudio offers you other ways to do so. A dialog window has been designed to help you to add features. Once you make it appear, the [[Opening the new feature dialog|new feature dialog]] allows you to choose what kind of feature you want to create and to set most of its characteristics. The process of creating the new feature is different if it is a [[Adding a procedure|procedure]] , a [[Adding a function|function]] or an [[Adding an attribute|attribute]] .
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|8779bb5f-44d4-48fa-7320-d3c02c3dc176]]
|
[[Property:uuid|8779bb5f-44d4-48fa-7320-d3c02c3dc176]]
|
||||||
To remove a feature, you may of course delete the corresponding lines in the class text. You can also use the Diagram tool if it is an attribute or a function. To do so, make sure that supplier links are shown in the diagram (if [[Image:diagram-supplier-link-icon]] is not pressed, click it). Pick the link that correspond to the feature you want to remove and drop the pebble on [[Image:16x16--general-delete-icon]] .
|
To remove a feature, you may of course delete the corresponding lines in the class text. You can also use the Diagram tool if it is an attribute or a function. To do so, make sure that supplier links are shown in the diagram (if [[Image:diagram-supplier-link-icon]] is not pressed, click it). Pick the link that correspond to the feature you want to remove and drop the pebble on [[Image:16x16--general-delete-icon]] .
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Adding a feature: Introduction|Adding a feature]] }}
|
[[Adding a feature]] }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -10,9 +10,10 @@ Under '''Create project''', several options are offered, which depend on the pla
|
|||||||
* '''.NET application''' has by default all essential components to start a project targeting the Microsoft .NET platform. Of course, it is only available on Windows, and only if you have chosen to install the .NET support during the installation.
|
* '''.NET application''' has by default all essential components to start a project targeting the Microsoft .NET platform. Of course, it is only available on Windows, and only if you have chosen to install the .NET support during the installation.
|
||||||
* '''Vision2 application''' creates a new project that includes the [[EiffelVision Introduction|Eiffel Vision2 library]] . This is the perfect choice to start a platform-independent graphic application, or even any graphic application, since EiffelVision2 is easier to use than platform-specific libraries. This option is available on all platforms.
|
* '''Vision2 application''' creates a new project that includes the [[EiffelVision Introduction|Eiffel Vision2 library]] . This is the perfect choice to start a platform-independent graphic application, or even any graphic application, since EiffelVision2 is easier to use than platform-specific libraries. This option is available on all platforms.
|
||||||
* '''WEL application''' generates a project using the [[WEL|Windows Eiffel Library(WEL)]] . This option is recommended for projects needing advanced Windows features, or Windows applications that are time-critical, since the graphic functionality provided by WEL is more efficient than the one provided by Vision2, which on the other hand provides a platform-independent abstract interface. This wizard is only available on Windows.
|
* '''WEL application''' generates a project using the [[WEL|Windows Eiffel Library(WEL)]] . This option is recommended for projects needing advanced Windows features, or Windows applications that are time-critical, since the graphic functionality provided by WEL is more efficient than the one provided by Vision2, which on the other hand provides a platform-independent abstract interface. This wizard is only available on Windows.
|
||||||
All those options are also available in the ''' File'''/ '''New project...''' menu. This pops up a dialog with all the options to generate a new project: [[Image:create-a-project]]
|
All those options are also available in the ''' File'''/ '''New project...''' menu. This pops up a dialog with all the options to generate a new project: <br/>[[Image:create-a-project]]
|
||||||
{{tip|If you checked the "Don't show this dialog at startup" checkbox in the start-up dialog but want to get it back, you can use the [[Discardable dialogs|Preferences dialog]] to reset the default value. }}
|
{{tip|If you checked the "Don't show this dialog at startup" checkbox in the start-up dialog but want to get it back, you can use the [[Discardable dialogs|Preferences dialog]] to reset the default value. }}
|
||||||
|
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Retrieving a project from a configuration file|Retrieving a project from an configuration file]] }}
|
[[Retrieving a project from a configuration file|Retrieving a project from an configuration file]] }}
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
[[Property:title|Address bars]]
|
[[Property:title|Address bars]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|e145c4d3-afd3-653d-cf7c-14fd80f4d566]]
|
[[Property:uuid|e145c4d3-afd3-653d-cf7c-14fd80f4d566]]
|
||||||
All development windows are composed of two major components, each of which can be centered on a given "address" (either a cluster, a class or a feature). One is the editor, with which go all the peripheral tools (including the [[Cluster tool|cluster tool]] and the [[Feature tool|feature tool]] ). The other is the context tool, which contains for example the [[Formatters: Introduction|class and feature tabs]] , the [[Diagram tool|diagram tool]] and the [[Metrics tool|metric tool]] .
|
All development windows are composed of two major components, each of which can be centered on a given "address" (either a cluster, a class or a feature). One is the editor, with which go all the peripheral tools (including the [[Cluster tool|cluster tool]] and the [[Feature tool|feature tool]] ). The other is the context tool, which contains for example the [[Formatted information about compiled classes and features|class and feature tabs]] , the [[Diagram tool|diagram tool]] and the [[Metrics tool|metric tool]] .
|
||||||
|
|
||||||
It is possible to either link both components so that they share the same address (allowing to immediately have extended information on the class that is being edited), or to unlink them (allowing to have extended information on any class while editing a class).
|
It is possible to either link both components so that they share the same address (allowing to immediately have extended information on the class that is being edited), or to unlink them (allowing to have extended information on any class while editing a class).
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
[[Property:title|New feature command]]
|
[[Property:title|New feature command]]
|
||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|3a670193-29dd-b829-0c90-eec8dd7e74b6]]
|
[[Property:uuid|3a670193-29dd-b829-0c90-eec8dd7e74b6]]
|
||||||
The new feature command [[Image:new-feature-icon]] located in the [[Feature tool|feature tool]] acts like the [[New feature dialog: Introduction|main new feature command]] . Clicking it pops up the same dialog, making it possible to add a new feature in the currently edited class.
|
The new feature command [[Image:new-feature-icon]] located in the [[Feature tool|feature tool]] acts like the [[New feature dialog|main new feature command]] . Clicking it pops up the same dialog, making it possible to add a new feature in the currently edited class.
|
||||||
|
|
||||||
This command is only available when the class currently in the editor is compiled, can be modified, and has a file on the disk (this may not be the case if the class is precompiled).
|
This command is only available when the class currently in the editor is compiled, can be modified, and has a file on the disk (this may not be the case if the class is precompiled).
|
||||||
|
|
||||||
|
|||||||
@@ -2,11 +2,9 @@
|
|||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|69b4d9d4-570e-e7ac-087b-88449a608d0b]]
|
[[Property:uuid|69b4d9d4-570e-e7ac-087b-88449a608d0b]]
|
||||||
EIS supports following protocols now:
|
EIS supports following protocols now:
|
||||||
*
|
* Raw URL: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
|
||||||
Raw URL: This protocol does not need to specified. By default, it will be taken if nothing is specified or unknown protocol is specified.
|
|
||||||
|
|
||||||
*
|
* PDF: PDF protocol supports three attributes for now. "type" "page" and "nameddest". (Windows only)
|
||||||
PDF: PDF protocol supports three attributes for now. "type" "page" and "nameddest". (Windows only)
|
|
||||||
** type: "file" is used to open PDF files in PDF reader. Otherwise in a browser.
|
** type: "file" is used to open PDF files in PDF reader. Otherwise in a browser.
|
||||||
** page: Specify the page number to navigate to.
|
** page: Specify the page number to navigate to.
|
||||||
** nameddest: Specify the named destination to navigate to.
|
** nameddest: Specify the named destination to navigate to.
|
||||||
|
|||||||
@@ -65,7 +65,7 @@ By default, the context tool is unlinked from the rest of the window, which mean
|
|||||||
[[Browsing tools|Browsing tools]] <br/>
|
[[Browsing tools|Browsing tools]] <br/>
|
||||||
[[Main toolbars|Toolbar customization]] <br/>
|
[[Main toolbars|Toolbar customization]] <br/>
|
||||||
[[EiffelStudio Editor Introduction|Editor reference]] <br/>
|
[[EiffelStudio Editor Introduction|Editor reference]] <br/>
|
||||||
[[Formatters: Introduction|Formatted information about compiled classes and features]] <br/>
|
[[Formatted information about compiled classes and features]] <br/>
|
||||||
[[Diagram tool: Introduction|Diagram reference]] <br/>
|
[[Diagram tool: Introduction|Diagram reference]] <br/>
|
||||||
[[Metrics tool|Metric tool]] }}
|
[[Metrics tool|Metric tool]] }}
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,6 @@
|
|||||||
[[Property:title|EiffelStudio Preferences]]
|
[[Property:title|EiffelStudio Preferences]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|780757a6-f04a-97d4-5069-d22328e6492f]]
|
[[Property:uuid|780757a6-f04a-97d4-5069-d22328e6492f]]
|
||||||
* [[EiffelStudio preferences: Introduction|Introduction]]
|
Many of EiffelStudio's properties may be customized. A tool has been designed to help you set your preferences. <br/>
|
||||||
* [[Preference window overview|Preferences dialog window]]
|
In this section, you will find a [[Preference window overview|description of this tool]] . You will also find [[Preferences Reference|an explanation of the different properties]] that may be modified by using it.
|
||||||
* [[Preferences Reference|Preferences reference]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ If there is no message stating you need to restart EiffelStudio, changes will be
|
|||||||
{{tip|you can export preferences to xml file, and import from xml file, this can be convenient when reinstalling EiffelStudio). }}
|
{{tip|you can export preferences to xml file, and import from xml file, this can be convenient when reinstalling EiffelStudio). }}
|
||||||
|
|
||||||
|
|
||||||
{{warning| '''Caution''': You can restore preferences default values by clicking on the "Restore Default" button. ALL preferences will be reset. }}
|
{{warning|If you restore default preferences values by clicking on the "Restore Default" button, then ALL preferences will be reset. }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,8 +3,7 @@
|
|||||||
[[Property:uuid|17738f37-4f85-c762-4074-5add286c9281]]
|
[[Property:uuid|17738f37-4f85-c762-4074-5add286c9281]]
|
||||||
This document contains the description of default completion for recognized keywords. The [[Keyword completion customization|syntax]] used is the one used to redefine keyword completion in the preferences. <br/>
|
This document contains the description of default completion for recognized keywords. The [[Keyword completion customization|syntax]] used is the one used to redefine keyword completion in the preferences. <br/>
|
||||||
Four tables list default values for each of the [[Keywords automatic completion preferences|four preferences]] attached to each keyword.
|
Four tables list default values for each of the [[Keywords automatic completion preferences|four preferences]] attached to each keyword.
|
||||||
#
|
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Space after keyword was typed)"]] <br/>
|
||||||
Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Space after keyword was typed)"]] <br/>
|
|
||||||
|
|
||||||
{| border="1"
|
{| border="1"
|
||||||
|-
|
|-
|
||||||
@@ -127,8 +126,7 @@ Default value for [[Keywords automatic completion preferences|"Customized autoco
|
|||||||
|}
|
|}
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
#
|
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Return after keyword was typed)"]] <br/>
|
||||||
Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Return after keyword was typed)"]] <br/>
|
|
||||||
|
|
||||||
{| border="1"
|
{| border="1"
|
||||||
|-
|
|-
|
||||||
@@ -251,8 +249,7 @@ Default value for [[Keywords automatic completion preferences|"Customized autoco
|
|||||||
|}
|
|}
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
#
|
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Space, other cases)"]] <br/>
|
||||||
Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Space, other cases)"]] <br/>
|
|
||||||
|
|
||||||
{| border="1"
|
{| border="1"
|
||||||
|-
|
|-
|
||||||
@@ -375,8 +372,7 @@ Default value for [[Keywords automatic completion preferences|"Customized autoco
|
|||||||
|}
|
|}
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
#
|
* Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Return, other cases)"]] <br/>
|
||||||
Default value for [[Keywords automatic completion preferences|"Customized autocomplete (Return, other cases)"]] <br/>
|
|
||||||
|
|
||||||
{| border="1"
|
{| border="1"
|
||||||
|-
|
|-
|
||||||
@@ -507,4 +503,3 @@ Default value for [[Keywords automatic completion preferences|"Customized autoco
|
|||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,11 +1,6 @@
|
|||||||
[[Property:title|Syntax automatic completion preferences]]
|
[[Property:title|Syntax automatic completion preferences]]
|
||||||
[[Property:weight|-1]]
|
[[Property:weight|-1]]
|
||||||
[[Property:uuid|9899c28c-c7c9-8d0d-1e83-e0d1741c7f3c]]
|
[[Property:uuid|9899c28c-c7c9-8d0d-1e83-e0d1741c7f3c]]
|
||||||
* [[EiffelStudio preferences for Automatic completion: Introduction|Introduction]]
|
EiffelStudio editor can detect many keywords and trigger an automatic syntax completion. <br/>
|
||||||
* [[Keywords automatic completion preferences|Keywords automatic completion preferences]]
|
This section of the documentation contains a description of [[Keywords automatic completion preferences|what can be customized]] . You will also find an [[Keyword completion customization|explanation of the syntax]] to be used in completion preferences, [[Default values for keyword completion preferences|and their default values]] .
|
||||||
* [[Keyword completion customization|Keyword completion customization]]
|
|
||||||
* [[Default values for keyword completion preferences|Default values for keyword completion preferences]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,14 +3,12 @@
|
|||||||
[[Property:uuid|5e41f619-9a27-d7a3-c722-07f7227c8952]]
|
[[Property:uuid|5e41f619-9a27-d7a3-c722-07f7227c8952]]
|
||||||
This document describes the syntax used to customize keyword automatic completion. <br/>
|
This document describes the syntax used to customize keyword automatic completion. <br/>
|
||||||
[[Keywords automatic completion preferences|Four strings]] are used to define the completion of a keyword. The rules are the same for all of them:
|
[[Keywords automatic completion preferences|Four strings]] are used to define the completion of a keyword. The rules are the same for all of them:
|
||||||
*
|
|
||||||
These strings will be inserted right after the keyword. The key that triggers the automatic completion will not be taken into account, i.e. no space or "new line" character will be inserted even though you press Return or Space. The strings should therefore begin with a space or a "new line" character (see below for "newline").
|
|
||||||
|
|
||||||
*
|
* These strings will be inserted right after the keyword. The key that triggers the automatic completion will not be taken into account, i.e. no space or "new line" character will be inserted even though you press Return or Space. The strings should therefore begin with a space or a "new line" character (see below for "newline").
|
||||||
Two reserved words will allow you to position the cursor and to indent the text properly. Insert the word ''$cursor$'' in the string where you want the cursor to be moved once the completion is finished. Insert the word ''$indent$'' where you want to copy as many blank spaces as there were on the line where the keyword was typed.
|
|
||||||
|
|
||||||
*
|
* Two reserved words will allow you to position the cursor and to indent the text properly. Insert the word ''$cursor$'' in the string where you want the cursor to be moved once the completion is finished. Insert the word ''$indent$'' where you want to copy as many blank spaces as there were on the line where the keyword was typed.
|
||||||
Three special characters are available:
|
|
||||||
|
* Three special characters are available:
|
||||||
** ''%N'' represents the new line character.
|
** ''%N'' represents the new line character.
|
||||||
** ''%T'' represents the tabulation
|
** ''%T'' represents the tabulation
|
||||||
** ''%B'' represents the back space
|
** ''%B'' represents the back space
|
||||||
|
|||||||
@@ -55,23 +55,18 @@ Keywords completion preferences can be found in the subdirectories of "Automatic
|
|||||||
==Usage==
|
==Usage==
|
||||||
|
|
||||||
A directory is associated with each keyword. These directories contains six items which you may modify to customize the automatic completion of the keyword:
|
A directory is associated with each keyword. These directories contains six items which you may modify to customize the automatic completion of the keyword:
|
||||||
*
|
|
||||||
Autocomplete <keyword>: If this is set to True, the automatic completion will be triggered when you type the keyword in the editor. If it is set to False, the keyword will be processed as a normal word.
|
|
||||||
|
|
||||||
*
|
* Autocomplete <keyword>: If this is set to True, the automatic completion will be triggered when you type the keyword in the editor. If it is set to False, the keyword will be processed as a normal word.
|
||||||
Use default autocomplete: If this is set to True, the next preferences will be ignored and the default completion scheme will be used. Otherwise, the automatic completion will use the user-defined strings described below.
|
|
||||||
|
|
||||||
*
|
* Use default autocomplete: If this is set to True, the next preferences will be ignored and the default completion scheme will be used. Otherwise, the automatic completion will use the user-defined strings described below.
|
||||||
Customized autocomplete (Return after keyword was typed): This [[Keyword completion customization|string]] defines what will be inserted as you press Return just after typing the keyword if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
|
||||||
|
|
||||||
*
|
* Customized autocomplete (Return after keyword was typed): This [[Keyword completion customization|string]] defines what will be inserted as you press Return just after typing the keyword if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
||||||
Customized autocomplete (Space after keyword was typed): This [[Keyword completion customization|string]] defines what will be inserted as you press Space just after typing the keyword if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
|
||||||
|
|
||||||
*
|
* Customized autocomplete (Space after keyword was typed): This [[Keyword completion customization|string]] defines what will be inserted as you press Space just after typing the keyword if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
||||||
Customized autocomplete (Return, other cases): This [[Keyword completion customization|string]] defines what will be inserted as you press Return after a keyword which had been previously typed. It is effective only if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
|
||||||
|
|
||||||
*
|
* Customized autocomplete (Return, other cases): This [[Keyword completion customization|string]] defines what will be inserted as you press Return after a keyword which had been previously typed. It is effective only if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
||||||
Customized autocomplete (Space, other cases): This [[Keyword completion customization|string]] defines what will be inserted as you press Space after a keyword which had been previously typed. It is effective only if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
|
||||||
|
* Customized autocomplete (Space, other cases): This [[Keyword completion customization|string]] defines what will be inserted as you press Space after a keyword which had been previously typed. It is effective only if you chose not to use the [[Default values for keyword completion preferences|default value]] (see Use default autocomplete above).
|
||||||
|
|
||||||
The syntax used in the four last item is described in [[Keyword completion customization|Keyword completion customization]] . [[Default values for keyword completion preferences|Default values]] are accessible in Keyword completion default values.
|
The syntax used in the four last item is described in [[Keyword completion customization|Keyword completion customization]] . [[Default values for keyword completion preferences|Default values]] are accessible in Keyword completion default values.
|
||||||
|
|
||||||
|
|||||||
@@ -1,12 +1,5 @@
|
|||||||
[[Property:title|Editor Preferences]]
|
[[Property:title|Editor Preferences]]
|
||||||
[[Property:weight|3]]
|
[[Property:weight|3]]
|
||||||
[[Property:uuid|fd7ec7c0-4c15-f2c2-70b7-82bc0a07a064]]
|
[[Property:uuid|fd7ec7c0-4c15-f2c2-70b7-82bc0a07a064]]
|
||||||
* [[EiffelStudio preferences for Editor: Introduction|Introduction]]
|
Some of the features of the EiffelStudio editor can be customized. This section of the documentation contains the necessary explanations to use the editor preferences. In addition to a description of [[General Editor Preferences|general preferences]] for the editor, you will find a document about [[Keyboard shortcuts preferences|user-definable keyboard shortcuts]] and a preferences for Eiffel specific preferences such as [[Syntax automatic completion preferences|automatic completion.]]
|
||||||
* [[General Editor Preferences|General preferences]]
|
|
||||||
* [[Eiffel Editor Preferences|Eiffel Specific preferences]]
|
|
||||||
* [[Keyboard shortcuts preferences|User-definable keyboard shortcuts]]
|
|
||||||
* [[Syntax automatic completion preferences|Syntax Autocompetion]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -10,12 +10,10 @@ Some of the keyboard shortcuts used in the editor can be customized. A subfolder
|
|||||||
* Show search panel: Shortcut to make the search panel appear if it is not displayed and to give the focus to the "Search for" field. The default key combination for this command is "Ctrl+F".
|
* Show search panel: Shortcut to make the search panel appear if it is not displayed and to give the focus to the "Search for" field. The default key combination for this command is "Ctrl+F".
|
||||||
* Show search and replace panel: Shortcut to make the search panel with the"Replace with" field appear if it is not displayed. The focus will be given to the "Search for" field. The default key combination for this command is"Ctrl+H".
|
* Show search and replace panel: Shortcut to make the search panel with the"Replace with" field appear if it is not displayed. The focus will be given to the "Search for" field. The default key combination for this command is"Ctrl+H".
|
||||||
|
|
||||||
'''Caution''': <br/>
|
{{note|You should avoid using key combinations made of only "Alt" and another key as they are reserved for menu shortcuts. }}
|
||||||
You should not use combinations made of only "Alt" and another key as they are reserved for menu shortcuts.
|
|
||||||
|
{{Tip|You may use combinations made of only one key to create very fast shortcuts, for example with the function keys. To know what string corresponds to a given key, you can look up in the EV_KEY_CONSTANTS of EiffelVision2.The `key_strings' table links keys with a string representation. }}
|
||||||
|
|
||||||
'''Tips''': <br/>
|
|
||||||
On the other hand, you may use combinations made of only a key to create very fast shortcuts, for example with the function keys. <br/>
|
|
||||||
To know what string corresponds to a given key, you can look up in the EV_KEY_CONSTANTS of EiffelVision2.The `key_strings' table links keys with a string representation.
|
|
||||||
|
|
||||||
There are three other categories in the shortcut preferences. These can be used to automatically insert a user-defined string in the editor. If you find yourself typing some strings very often, these preferences can be handy.
|
There are three other categories in the shortcut preferences. These can be used to automatically insert a user-defined string in the editor. If you find yourself typing some strings very often, these preferences can be handy.
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,7 @@
|
|||||||
[[Property:title|EiffelStudio Tools Preferences]]
|
[[Property:title|EiffelStudio Tools Preferences]]
|
||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|76e278d3-c15d-43ba-ac79-611b05761b76]]
|
[[Property:uuid|76e278d3-c15d-43ba-ac79-611b05761b76]]
|
||||||
* [[EiffelStudio preferences for Tools: Introduction|Introduction]]
|
This section of the help deals with preferences related to a tool in particular. These preferences are distributed in two categories:
|
||||||
* [[Context Tools|Context tools]]
|
* A [[Context Tools]] category used to change preferences related to context tools.
|
||||||
* [[EiffelStudio Diagram Tool Preferences|Diagram Tool]]
|
* A [[EiffelStudio Diagram Tool Preferences|Diagram Tools]] category used to customize some features of the diagram tool, mainlycolors and fonts for graphical element display.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -2,13 +2,4 @@
|
|||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|a93a61b7-4814-e8a8-0379-52c0012f5935]]
|
[[Property:uuid|a93a61b7-4814-e8a8-0379-52c0012f5935]]
|
||||||
The top level preference categories for EiffelStudio preferences are listed below.
|
The top level preference categories for EiffelStudio preferences are listed below.
|
||||||
* [[General Preferences|General]]
|
|
||||||
* [[Interface|Interface]]
|
|
||||||
* [[EiffelStudio Tools Preferences|Tools ]]
|
|
||||||
* [[Editor Preferences|Editor]]
|
|
||||||
* [[Debugger Preferences|Debugger]]
|
|
||||||
* [[Recent Project Preferences|Recent Projects]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,5 @@
|
|||||||
[[Property:title|Interface]]
|
[[Property:title|Interface]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|e0fe1870-cf02-4ca9-e46a-e69c8db1ed48]]
|
[[Property:uuid|e0fe1870-cf02-4ca9-e46a-e69c8db1ed48]]
|
||||||
* [[EiffelStudio preferences for Interface: Introduction|Introduction]]
|
This section of the documentation describes preferences that belong to the "Interface" category. This group contains two kinds of properties, some related to the preferences for the EiffelStudio [[Development Window Preferences|development window]] , others that define which [[Discardable dialogs|dialog windows]] should or should not be displayed. You can also decide to use animated icons in the status bars whenever possible (that is, during compilations and executions).
|
||||||
* [[Preferences Reference|EiffelStudio development window preferences]]
|
|
||||||
* [[Discardable dialogs|Discardable dialog windows]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,8 @@ Basic text view [[Image:view-editor-icon]] is the only editable view; this is
|
|||||||
This is also the view selected by default when the editor is opened for the first time.
|
This is also the view selected by default when the editor is opened for the first time.
|
||||||
In this view, most of the development objects are [[Pick-and-drop mechanism|clickable]] , except for special cases like assertions, anchored types, identifiers within a comment line... for which the [[Clickable view|clickable view]] might be needed.
|
In this view, most of the development objects are [[Pick-and-drop mechanism|clickable]] , except for special cases like assertions, anchored types, identifiers within a comment line... for which the [[Clickable view|clickable view]] might be needed.
|
||||||
|
|
||||||
'''Note''': The generated text is not editable, but it is compilable. This view is not available to .NET classes which are imported through by means of an assembly. This is because the assembly .exe or .dll exposes only the interface methods and therefore is no implementation to display. Such classes may be viewed, in a clickable format using the Contract View or Interface View.
|
{{note|The generated text is not editable, but it is compilable. This view is not available to .NET classes which are imported through by means of an assembly. This is because the assembly .exe or .dll exposes only the interface methods and therefore is no implementation to display. Such classes may be viewed, in a clickable format using the Contract View or Interface View. }}
|
||||||
|
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[EiffelStudio Editor|Editor]] }}
|
[[EiffelStudio Editor|Editor]] }}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|14ad347a-db72-1194-346b-752e1cd0dc7d]]
|
[[Property:uuid|14ad347a-db72-1194-346b-752e1cd0dc7d]]
|
||||||
The flat view [[Image:view-flat-icon]] displays all the features for the current class, i.e. including both written-in and inherited features; it is available either through the [[EiffelStudio Editor|editor]] or through the '''Class''' tab of the [[EiffelStudio window overview|context tool]] . This is also the only view where [[Breakpoints|breakpoints]] are displayed.
|
The flat view [[Image:view-flat-icon]] displays all the features for the current class, i.e. including both written-in and inherited features; it is available either through the [[EiffelStudio Editor|editor]] or through the '''Class''' tab of the [[EiffelStudio window overview|context tool]] . This is also the only view where [[Breakpoints|breakpoints]] are displayed.
|
||||||
|
|
||||||
{{warning| '''Caution''': For classes with many [[Ancestors|ancestors]] , computation of the flat view may require a few seconds. }}
|
{{warning|For classes with many [[Ancestors|ancestors]] , computation of the flat view may require a few seconds. }}
|
||||||
|
|
||||||
{{note|This view is not available to .NET classes which are imported through by means of an assembly. This is because the assembly .exe or .dll exposes only the interface methods and therefore is no implementation to display. Such classes may be viewed, in a clickable format using the Contract View or Interface View. }}
|
{{note|This view is not available to .NET classes which are imported through by means of an assembly. This is because the assembly .exe or .dll exposes only the interface methods and therefore is no implementation to display. Such classes may be viewed, in a clickable format using the Contract View or Interface View. }}
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|dbbbb655-aa38-849f-62c5-e1bda6f83285]]
|
[[Property:uuid|dbbbb655-aa38-849f-62c5-e1bda6f83285]]
|
||||||
The Flat Contract view [[Image:view-flat-contracts-icon]] displays the contracts of all written-in and inherited features of the current class. It is available either through the [[EiffelStudio Editor|editor]] or through the '''Class''' tab of the [[EiffelStudio window overview|context tool]] .
|
The Flat Contract view [[Image:view-flat-contracts-icon]] displays the contracts of all written-in and inherited features of the current class. It is available either through the [[EiffelStudio Editor|editor]] or through the '''Class''' tab of the [[EiffelStudio window overview|context tool]] .
|
||||||
|
|
||||||
{{warning| '''Caution''': For classes with many [[Ancestors|ancestors]] , computation of the Flat Contract view may require a few seconds. }}
|
{{warning|For classes with many [[Ancestors|ancestors]], computation of the Flat Contract view may require a few seconds. }}
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Class formatters: Flat view|Flat view]] <br/>
|
[[Class formatters: Flat view|Flat view]] <br/>
|
||||||
|
|||||||
@@ -1,22 +1,27 @@
|
|||||||
[[Property:title|Class views]]
|
[[Property:title|Class views]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|dd076484-eccd-41d6-538e-bf261529b43e]]
|
[[Property:uuid|dd076484-eccd-41d6-538e-bf261529b43e]]
|
||||||
* [[Class formatters: Introduction|Introduction]]
|
[[Image:class-format-bar]]
|
||||||
* [[Class formatters: Basic text view|Basic text view]]
|
|
||||||
* [[Clickable view|Clickable view]]
|
Class views are all available through the '''Class''' tab of the [[EiffelStudio window overview|context tool]] , and for some of them directly with the [[EiffelStudio Editor|editor]] . <br/>
|
||||||
* [[Class formatters: Flat view|Flat view]]
|
These views (with their associated icon) are:
|
||||||
* [[Contract view|Contract view]]
|
* [[Image:view-editor-icon]] [[Class formatters: Basic text view|Basic text view]]
|
||||||
* [[Flat Contract view|Flat Contract view]]
|
* [[Image:view-clickable-icon]] [[Clickable view|Clickable view]]
|
||||||
* [[Ancestors|Ancestors]]
|
* [[Image:view-flat-icon]] [[Class formatters: Flat view|Flat view]]
|
||||||
* [[Descendants|Descendants]]
|
* [[Image:view-contracts-icon]] [[Contract view|Contract view]]
|
||||||
* [[Clients|Clients]]
|
* [[Image:view-flat-contracts-icon]] [[Flat Contract view|Flat Contract view]]
|
||||||
* [[Suppliers|Suppliers]]
|
* [[Image:class-ancestors-icon]] [[Ancestors|Ancestors]]
|
||||||
* [[Attributes|Attributes]]
|
* [[Image:class-descendents-icon]] [[Descendants|Descendants]]
|
||||||
* [[Routines|Routines]]
|
* [[Image:class-clients-icon]] [[Clients|Clients]]
|
||||||
* [[Deferred features|Deferred features]]
|
* [[Image:class-supliers-icon]] [[Suppliers|Suppliers]]
|
||||||
* [[Once routines and constants|Once routines and constants]]
|
* [[Image:class-features-attribute-icon]] [[Attributes|Attributes]]
|
||||||
* [[Class formatters: External features|External features]]
|
* [[Image:class-features-routine-icon]] [[Routines|Routines]]
|
||||||
* [[Exported features|Exported features]]
|
* [[Image:class-features-invariant-icon]] [[Invariants|Invariants]]
|
||||||
|
* [[Image:class-features-creator-icon]] [[Creators|Creators]]
|
||||||
|
* [[Image:class-features-deferred-icon]] [[Deferred features|Deferred features]]
|
||||||
|
* [[Image:class-features-once-icon]] [[Once routines and constants|Once routines and constants]]
|
||||||
|
* [[Image:class-features-external-icon]] [[Class formatters: External features|External features]]
|
||||||
|
* [[Image:class-features-exported-icon]] [[Exported features|Exported features]]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,8 @@
|
|||||||
Basic text view [[Image:view-editor-feature-icon]] displays the text of the current feature as it is written in the enclosing class. <br/>
|
Basic text view [[Image:view-editor-feature-icon]] displays the text of the current feature as it is written in the enclosing class. <br/>
|
||||||
It does not work with [[Breakpoints|breakpoints]] ; in order to do this the [[Feature formatters: Flat view|flat view]] has to be used.
|
It does not work with [[Breakpoints|breakpoints]] ; in order to do this the [[Feature formatters: Flat view|flat view]] has to be used.
|
||||||
|
|
||||||
'''Note''': This view is not available to .NET features which are imported through by means of an assembly. This is because the assembly .exe or .dll exposes only the interface methods and therefore is no feature implementation to display. The feature interface may be viewed, in a clickable format using the Flat View.
|
{{note|This view is not available to .NET features which are imported through by means of an assembly. This is because the assembly .exe or .dll exposes only the interface methods and therefore is no feature implementation to display. The feature interface may be viewed, in a clickable format using the Flat View. }}
|
||||||
|
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Class formatters: Basic text view|Class basic text view]] }}
|
[[Class formatters: Basic text view|Class basic text view]] }}
|
||||||
|
|||||||
@@ -4,7 +4,7 @@
|
|||||||
[[Property:uuid|933b22f0-c181-fd65-9b52-be20270b00af]]
|
[[Property:uuid|933b22f0-c181-fd65-9b52-be20270b00af]]
|
||||||
The homonyms view [[Image:feature-homonyms-icon]] displays all the features in the system which have the same name as the current feature.
|
The homonyms view [[Image:feature-homonyms-icon]] displays all the features in the system which have the same name as the current feature.
|
||||||
|
|
||||||
{{warning| '''Caution''': This operation may take a long time if the system has a lot of classes. }}
|
{{warning|: This operation may take a long time if the system has a lot of classes. }}
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Implementers|Implementers]] }}
|
[[Implementers|Implementers]] }}
|
||||||
|
|||||||
@@ -1,15 +1,22 @@
|
|||||||
[[Property:title|Feature views]]
|
[[Property:title|Feature views]]
|
||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|81c09c3a-0c0e-ecab-b708-0f5cd8860031]]
|
[[Property:uuid|81c09c3a-0c0e-ecab-b708-0f5cd8860031]]
|
||||||
* [[Feature formatters: Introduction|Introduction]]
|
[[Image:feature-format-bar]]
|
||||||
* [[Feature formatters: Basic text view|Basic text view]]
|
|
||||||
* [[Feature formatters: Flat view|Flat view]]
|
Feature views are all available through the '''Feature''' tab of the [[EiffelStudio window overview|context tool]] . <br/>
|
||||||
* [[Callers|Callers]]
|
These views (and their associated icon) are:
|
||||||
* [[Implementers|Implementers]]
|
* [[Image:view-editor-feature-icon]] [[Feature formatters: Basic text view|Basic text view]]
|
||||||
* [[Ancestor versions|Ancestor versions]]
|
* [[Image:view-clickable-feature-icon]] [[Feature formatters: Flat view|Clickable view]]
|
||||||
* [[Descendant versions|Descendant versions]]
|
* [[Image:feature-callers-icon]] [[Callers|Callers]]
|
||||||
* [[Homonyms|Homonyms]]
|
* [[Image:feature-assigners-icon]] Assigners
|
||||||
|
* [[Image:feature-creators-icon]] Creators
|
||||||
|
* [[Image:feature-callees-icon]] Callees
|
||||||
|
* [[Image:feature-assignees-icon]] Assignees
|
||||||
|
* [[Image:feature-creaters-icon]] Creations
|
||||||
|
* [[Image:feature-implementers-icon]] [[Implementers|Implementers]]
|
||||||
|
* [[Image:feature-ancestors-icon]] [[Ancestor versions|Ancestor versions]]
|
||||||
|
* [[Image:feature-descendents-icon]] [[Descendant versions|Descendant versions]]
|
||||||
|
* [[Image:feature-homonyms-icon]] [[Homonyms|Homonyms]]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,10 +1,5 @@
|
|||||||
[[Property:title|Formatted information about compiled classes and features]]
|
[[Property:title|Formatted information about compiled classes and features]]
|
||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|487a89c3-14a7-26c4-ae87-f3442f315bc3]]
|
[[Property:uuid|487a89c3-14a7-26c4-ae87-f3442f315bc3]]
|
||||||
* [[Formatters: Introduction|Introduction]]
|
Different kinds of information about classes and features can be seen in EiffelStudio depending on the developer's needs.
|
||||||
* [[Class views|Class views]]
|
|
||||||
* [[Feature views|Feature views]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|ef89f3c3-180e-3390-74b5-d6d537921453]]
|
[[Property:uuid|ef89f3c3-180e-3390-74b5-d6d537921453]]
|
||||||
Some of our metrics will be elementary and some composite. An elementary metric is measured directly from the product or a project record:
|
Some of our metrics will be elementary and some composite. An elementary metric is measured directly from the product or a project record:
|
||||||
|
|
||||||
{{note| '''Elementary_metric''': <br/>
|
{{definition|Elementary product metric, elementary process metric|<br/>
|
||||||
- An '''elementary product metric''' is a product metric whose values (integers) indicate the number of occurrences of a certain pattern in a product. <br/>
|
- An '''elementary product metric''' is a product metric whose values (integers) indicate the number of occurrences of a certain pattern in a product. <br/>
|
||||||
- An '''elementary process metric''' is a process metric whose values reflect measurements drawn directly from project records. }}
|
- An '''elementary process metric''' is a process metric whose values reflect measurements drawn directly from project records. }}
|
||||||
|
|
||||||
@@ -13,11 +13,11 @@ Elementary metrics are provided by default by the metric tool. There is no means
|
|||||||
|
|
||||||
From these elementary metrics we may define composite ones:
|
From these elementary metrics we may define composite ones:
|
||||||
|
|
||||||
{{note| '''Composite metric ''': A '''composite metric''' is a metric whose values are defined by a mathematical formula involving other metrics (elementary, or previously defined composite metrics). }}
|
{{definition|Composite metric|A '''composite metric''' is a metric whose values are defined by a mathematical formula involving other metrics (elementary, or previously defined composite metrics). }}
|
||||||
A later section will introduce a number of operations for defining composite metrics out of elementary ones.
|
A later section will introduce a number of operations for defining composite metrics out of elementary ones.
|
||||||
Again we may distinguish between product and process:
|
Again we may distinguish between product and process:
|
||||||
|
|
||||||
{{note| '''Composite product metric, composite process metric:''' <br/>
|
{{definition|Composite product metric, composite process metric|<br/>
|
||||||
- A '''composite product metric''' is a composite metric defined entirely in terms of product metrics. <br/>
|
- A '''composite product metric''' is a composite metric defined entirely in terms of product metrics. <br/>
|
||||||
- A '''composite process metric''' is a composite metric whose definition involves one or more process metrics. }}
|
- A '''composite process metric''' is a composite metric whose definition involves one or more process metrics. }}
|
||||||
|
|
||||||
|
|||||||
@@ -6,11 +6,10 @@ If you want to perform measurements on a system that you are building, the scope
|
|||||||
It would be impractical in this case to require tools that have access to as much information on external systems as on your own. All we really need is a record of previous measurements on these systems. This explains the fifth scope type, Archive: beyond the scope of the current system, all we require to define a scope is a '''measurement archive''', or just "archive" for short. This is simply a file (or part of a file) that retains, in a suitable format (XML-based), the results of measurements made earlier on one system. The file can be local or accessible as a URL on the Internet.
|
It would be impractical in this case to require tools that have access to as much information on external systems as on your own. All we really need is a record of previous measurements on these systems. This explains the fifth scope type, Archive: beyond the scope of the current system, all we require to define a scope is a '''measurement archive''', or just "archive" for short. This is simply a file (or part of a file) that retains, in a suitable format (XML-based), the results of measurements made earlier on one system. The file can be local or accessible as a URL on the Internet.
|
||||||
|
|
||||||
The ability to use a measurement archive as a scope means that:
|
The ability to use a measurement archive as a scope means that:
|
||||||
*
|
|
||||||
A project may set up a measurement archive as the record of its measures.
|
|
||||||
|
|
||||||
*
|
* A project may set up a measurement archive as the record of its measures.
|
||||||
A department or company may set up a measurement archive for all projects on which it keeps metric information.
|
|
||||||
|
* A department or company may set up a measurement archive for all projects on which it keeps metric information.
|
||||||
|
|
||||||
* The provider of the development environment, such as Eiffel Software, may publish a set of measurement archives giving metric information for reference projects, such as the EiffelBase library (designed in part as a showcase of Eiffel technology). Eiffle Software indeed intends to include a '''metrics''' directory, with a set of measurement archives for reference tools and libraries, in forthcoming releases of EiffelStudio and at [http://www.eiffel.com/ http://www.eiffel.com/] .
|
* The provider of the development environment, such as Eiffel Software, may publish a set of measurement archives giving metric information for reference projects, such as the EiffelBase library (designed in part as a showcase of Eiffel technology). Eiffle Software indeed intends to include a '''metrics''' directory, with a set of measurement archives for reference tools and libraries, in forthcoming releases of EiffelStudio and at [http://www.eiffel.com/ http://www.eiffel.com/] .
|
||||||
|
|
||||||
|
|||||||
@@ -3,13 +3,12 @@
|
|||||||
[[Property:uuid|5e76bd87-b7a7-8307-0e9e-ca9bb31db0f9]]
|
[[Property:uuid|5e76bd87-b7a7-8307-0e9e-ca9bb31db0f9]]
|
||||||
You will want to rely not on a single metric but on a combination of metrics:
|
You will want to rely not on a single metric but on a combination of metrics:
|
||||||
|
|
||||||
{{note| '''Metric framework''': A '''metric framework''' is a set of definitions of metrics. }}
|
{{definition|Metric framework|A '''metric framework''' is a set of definitions of metrics. }}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
Any metric work should be backed by a theory:
|
Any metric work should be backed by a theory:
|
||||||
|
|
||||||
{{note| '''Metric theory''': A '''metric theory''' is a combination of: <br/>
|
{{definition|Metric theory|A '''metric theory''' is a combination of: <br/>
|
||||||
- A metric framework <br/>
|
- A metric framework <br/>
|
||||||
- A set of definitions of attributes (qualitative or quantitative) <br/>
|
- A set of definitions of attributes (qualitative or quantitative) <br/>
|
||||||
- A mapping from the framework to the set of attributes, representing the hypothesis that each metric is a good predictor of the associated attribute }}
|
- A mapping from the framework to the set of attributes, representing the hypothesis that each metric is a good predictor of the associated attribute }}
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ and so on. Many combinations of these properties may be worth counting on their
|
|||||||
|
|
||||||
To avoid this we must identify a subset of elementary metrics as '''raw metrics''': metrics whose results are counted directly. "Number of features in a class" is a raw metric. From a raw metric, we may then derive other elementary metrics by applying '''selection criteria''' such as "Is this feature an attribute?" or "Is this feature exported?" Here are the definitions:
|
To avoid this we must identify a subset of elementary metrics as '''raw metrics''': metrics whose results are counted directly. "Number of features in a class" is a raw metric. From a raw metric, we may then derive other elementary metrics by applying '''selection criteria''' such as "Is this feature an attribute?" or "Is this feature exported?" Here are the definitions:
|
||||||
|
|
||||||
{{note| '''Raw metric, selection criterion, derived metric:''' <br/>
|
{{definition|Raw metric, selection criterion, derived metric|<br/>
|
||||||
An elementary metric is either '''raw''' or '''derived'''. A '''selection criterion''' for a raw metric is a property, with a fixed set of possible values (two or more), characterizing the patterns or events being counted by the metric. <br/>
|
An elementary metric is either '''raw''' or '''derived'''. A '''selection criterion''' for a raw metric is a property, with a fixed set of possible values (two or more), characterizing the patterns or events being counted by the metric. <br/>
|
||||||
A '''derived metric''' is an elementary metric defined from a raw metric by counting only the patterns satisfying a certain combination of its selection criteria. }}
|
A '''derived metric''' is an elementary metric defined from a raw metric by counting only the patterns satisfying a certain combination of its selection criteria. }}
|
||||||
|
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|303fb469-9f2b-d7cc-55e7-d657fb87b8fe]]
|
[[Property:uuid|303fb469-9f2b-d7cc-55e7-d657fb87b8fe]]
|
||||||
Every metric has a scope:
|
Every metric has a scope:
|
||||||
|
|
||||||
{{note| '''Scope of a metric''': <br/>
|
{{definition|Scope of a metric|<br/>
|
||||||
The '''scope''' of a metric is defined as follows: <br/>
|
The '''scope''' of a metric is defined as follows: <br/>
|
||||||
- For a raw product metric, the type of product over which the metric is counted, such as: a feature, a class, a group, an archive built for a given system to make it possible to compare systems. <br/>
|
- For a raw product metric, the type of product over which the metric is counted, such as: a feature, a class, a group, an archive built for a given system to make it possible to compare systems. <br/>
|
||||||
- For a raw process metric, the type of process on which the metric is measured, such as analysis, documentation, entire project etc. <br/>
|
- For a raw process metric, the type of process on which the metric is measured, such as analysis, documentation, entire project etc. <br/>
|
||||||
@@ -14,7 +14,7 @@ The '''scope''' of a metric is defined as follows: <br/>
|
|||||||
|
|
||||||
This notion also applies to measures:
|
This notion also applies to measures:
|
||||||
|
|
||||||
{{note| '''Scope of a measure''': <br/>
|
{{definition|Scope of a measure|<br/>
|
||||||
The '''scope''' of a measure is defined as follows: <br/>
|
The '''scope''' of a measure is defined as follows: <br/>
|
||||||
- For an elementary measure (the application of an elementary metric, raw or derived), the set of products or processes to which the associated metric has been applied to yield the measure. <br/>
|
- For an elementary measure (the application of an elementary metric, raw or derived), the set of products or processes to which the associated metric has been applied to yield the measure. <br/>
|
||||||
- For a composite measure, the union of (recursively) the scopes of its constituent measures. }}
|
- For a composite measure, the union of (recursively) the scopes of its constituent measures. }}
|
||||||
|
|||||||
@@ -3,7 +3,7 @@
|
|||||||
[[Property:uuid|c8793405-c91d-c04b-10ed-07739728f697]]
|
[[Property:uuid|c8793405-c91d-c04b-10ed-07739728f697]]
|
||||||
The metric archive panel is used to calculate and restore metric archives and to do metric archive comparison.
|
The metric archive panel is used to calculate and restore metric archives and to do metric archive comparison.
|
||||||
|
|
||||||
==Metric Archiv Calculation==
|
==Metric Archive Calculation==
|
||||||
|
|
||||||
Let's have a look at the buttons and options related to metric archive calculataion:
|
Let's have a look at the buttons and options related to metric archive calculataion:
|
||||||
|
|
||||||
|
|||||||
@@ -12,11 +12,11 @@ Let's first have a look at the buttons in the main toolbar, see the following fi
|
|||||||
[[Image:metrics-tool--debug-run-icon|Defining an input domain]] Start metric evaluation <br/>
|
[[Image:metrics-tool--debug-run-icon|Defining an input domain]] Start metric evaluation <br/>
|
||||||
Press this button to start evaluating the currently selected metric.
|
Press this button to start evaluating the currently selected metric.
|
||||||
|
|
||||||
[[Image:metrics-tool--debug-stop-icon|Defining an input domain]] Stope metric<br/>
|
[[Image:metrics-tool--debug-stop-icon|Defining an input domain]] Stop metric<br/>
|
||||||
Press this button to terminate a running metric evaluation.
|
Press this button to terminate a running metric evaluation.
|
||||||
|
|
||||||
[[Image:metrics-tool--metric-send-to-archive-icon|Defining an input domain]] Send last result to metric history<br/>
|
[[Image:metrics-tool--metric-send-to-archive-icon|Defining an input domain]] Send last result to metric history<br/>
|
||||||
After a metric evaluation this button will be sensitive and clicking it will record the evaluated metric as well as it's input domain and result in the metric history. This faciliates to evaluate it again and let's you compare different metric runs.
|
After a metric evaluation this button will be sensitive and clicking it will record the evaluated metric as well as its input domain and result in the metric history. This facilitates evaluating it again and lets you compare different metric runs.
|
||||||
|
|
||||||
[[Image:metrics-tool--metric-run-and-show-details-icon|Defining an input domain]] Keep detailed result when evaluating metric<br/>
|
[[Image:metrics-tool--metric-run-and-show-details-icon|Defining an input domain]] Keep detailed result when evaluating metric<br/>
|
||||||
Normally, evaluating a metric will give you a number as result, but sometimes, you want to investigate into those items which make up that value. For example, evaluating '''Classes''' metric over the base library gives you 242, which means there are 242 classes in the base library, and sometimes, you want to know which they are. With this option enabled, you'll have a detailed result listed in the detailed result panel after a metric evaluation. This option only has effect when evaluating basic metrics, because the detailed result has no meaning for derived metrics (linear or ratio metrics) in general. Suppose you have a linear metric defined as 5 * Classes, then the notion of detailed result has no meaning. Another use of this option is for performance: keeping a detailed result can be quite expensive in some cases, such as when you calculate the metric '''Lines of code''' for a large system, which may result in hundred of thousands of lines in the result. So turning it off in such as case may be a good idea.
|
Normally, evaluating a metric will give you a number as result, but sometimes, you want to investigate into those items which make up that value. For example, evaluating '''Classes''' metric over the base library gives you 242, which means there are 242 classes in the base library, and sometimes, you want to know which they are. With this option enabled, you'll have a detailed result listed in the detailed result panel after a metric evaluation. This option only has effect when evaluating basic metrics, because the detailed result has no meaning for derived metrics (linear or ratio metrics) in general. Suppose you have a linear metric defined as 5 * Classes, then the notion of detailed result has no meaning. Another use of this option is for performance: keeping a detailed result can be quite expensive in some cases, such as when you calculate the metric '''Lines of code''' for a large system, which may result in hundred of thousands of lines in the result. So turning it off in such as case may be a good idea.
|
||||||
|
|||||||
@@ -1,10 +1,5 @@
|
|||||||
[[Property:title|Dialogs]]
|
[[Property:title|Dialogs]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|5d543cd3-8e54-e090-44d4-ee3b51009fe6]]
|
[[Property:uuid|5d543cd3-8e54-e090-44d4-ee3b51009fe6]]
|
||||||
* [[New feature dialog|New feature dialog]]
|
|
||||||
* [[Error descriptor|Error descriptor]]
|
|
||||||
* [[External commands editor dialog|External commands editor]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,13 +1,14 @@
|
|||||||
[[Property:title|New feature dialog]]
|
[[Property:title|New feature dialog]]
|
||||||
[[Property:weight|0]]
|
[[Property:weight|0]]
|
||||||
[[Property:uuid|deb4901a-7b5a-f669-802e-de1efefcc1a0]]
|
[[Property:uuid|deb4901a-7b5a-f669-802e-de1efefcc1a0]]
|
||||||
* [[New feature dialog: Introduction|Introduction]]
|
The new feature dialog window lets you create simple Eiffel features using the coding standards described in [http://www.eiffel.com/doc/oosc/ Object-Oriented Software Construction, Second Edition]. It automates the task of writing set-procedures for attributes and it makes it easy for you to find the right feature clause for a new feature. The new feature dialog can be invoked whenever you have a class open in a development window. It is also used by the diagram tool when creating a client-supplier link.
|
||||||
* [[New feature dialog overview|Overview]]
|
|
||||||
* [[New procedure layout|Procedure layout]]
|
|
||||||
* [[New function layout|Function layout]]
|
|
||||||
* [[New attribute layout|Attribute layout]]
|
|
||||||
* [[New feature dialog: feature properties modification|Feature properties modification]]
|
|
||||||
|
|
||||||
|
|
||||||
|
==Use it when...==
|
||||||
|
* You want to be introduced to the style rules for Eiffel code as described in [http://www.eiffel.com/doc/oosc/ Object-Oriented Software Construction, Second Edition] , chapter 26.5 (page 891).
|
||||||
|
* You want to create an attribute and you also want an invariant and/or a set-procedure generated for it.
|
||||||
|
* You want to add a feature in a feature clause that is not in your class yet, and you do not remember the feature clause order, or you want to add it in a feature clause that is in your class, but you cannot find it.
|
||||||
|
|
||||||
|
==Do not use it when...==
|
||||||
|
* You want to edit an existing feature. This is not possible, you can only create new features with it.
|
||||||
|
* You want to write a more advanced feature. With the feature wizard, you can enter only a single line of code.
|
||||||
|
|
||||||
|
|||||||
@@ -11,7 +11,9 @@ When clicking '''Attribute''', the window changes to the attribute layout. It ha
|
|||||||
* [[Set-procedure|Set-procedure check box]]
|
* [[Set-procedure|Set-procedure check box]]
|
||||||
|
|
||||||
==Example==
|
==Example==
|
||||||
<div> [[Image:feature-wizard-attribute-example]] </div>
|
This dialog box:<br/>
|
||||||
|
<div> [[Image:feature-wizard-attribute-example]] </div><br/>
|
||||||
|
Produces this feature:<br/>
|
||||||
<code>class
|
<code>class
|
||||||
PRODUCT
|
PRODUCT
|
||||||
|
|
||||||
|
|||||||
@@ -3,12 +3,15 @@
|
|||||||
[[Property:uuid|f2d63c29-6be2-b3d9-a735-b18e08c5a678]]
|
[[Property:uuid|f2d63c29-6be2-b3d9-a735-b18e08c5a678]]
|
||||||
For functions and procedures, you can build a formal argument list. You can do this by clicking on the '''New argument''' button as many times as you need arguments.
|
For functions and procedures, you can build a formal argument list. You can do this by clicking on the '''New argument''' button as many times as you need arguments.
|
||||||
|
|
||||||
{{note|Even though this dialog always shows parentheses, they are not generated if the list is empty (Eiffel's command-query separation (CQS) principle). }}
|
{{note|Even though this dialog always shows parentheses, if the list is empty, empty parentheses will not generated. In other words, the dialog will generate the correct Eiffel syntax. }}
|
||||||
<div> [[Image:feature-wizard-3-arguments]] </div>
|
|
||||||
|
|
||||||
|
<div> [[Image:feature-wizard-3-arguments]] </div><br/>
|
||||||
{{note|If you add arguments to a routine, it is not possible anymore to select routine type '''once'''. }}
|
{{note|If you add arguments to a routine, it is not possible anymore to select routine type '''once'''. }}
|
||||||
|
|
||||||
|
|
||||||
For every attribute you selected, enter a name in the text box and a type using the [[Type selection|type selection]] .
|
For every attribute you selected, enter a name in the text box and a type using the [[Type selection|type selection]] .
|
||||||
<div> [[Image:feature-wizard-1-argument]] </div>
|
<div> [[Image:feature-wizard-1-argument]] </div><br/>
|
||||||
The code that is generated:
|
The code that is generated:
|
||||||
<code>set_name (s: STRING) is
|
<code>set_name (s: STRING) is
|
||||||
do
|
do
|
||||||
|
|||||||
@@ -3,22 +3,22 @@
|
|||||||
[[Property:uuid|019ea318-e0e0-dae9-a818-e12232aa8431]]
|
[[Property:uuid|019ea318-e0e0-dae9-a818-e12232aa8431]]
|
||||||
The feature you create will be inserted in the feature clause you specified. If the feature clause was not already in your class, or not in the right place, EiffelStudio adds the feature clause to the class text based on the feature clause order specified in the [[Preferences Reference|preferences]] . By default, this is the order used by the Eiffel Software libraries, such as EiffelBase.
|
The feature you create will be inserted in the feature clause you specified. If the feature clause was not already in your class, or not in the right place, EiffelStudio adds the feature clause to the class text based on the feature clause order specified in the [[Preferences Reference|preferences]] . By default, this is the order used by the Eiffel Software libraries, such as EiffelBase.
|
||||||
==Export status==
|
==Export status==
|
||||||
The export status is the class the feature is accessible for. Usually, this is <eiffel>ANY</eiffel> for public features, or <eiffel>NONE</eiffel> for implementation features, but you can specify any class here.
|
The export status is the class the feature is accessible for. Usually, this is <eiffel>ANY</eiffel> for public features, or <eiffel>NONE</eiffel> for implementation features, but you can specify any class here. <br/>
|
||||||
[[Image:feature-wizard-export]]
|
[[Image:feature-wizard-export]]
|
||||||
|
|
||||||
{{note|In the class text, you can export a feature to more than one class but (for simplicity) not with this dialog. }}
|
{{note|In the class text, you can export a feature to more than one class but (for simplicity) not with this dialog. }}
|
||||||
|
|
||||||
==Feature clause names==
|
==Feature clause names==
|
||||||
For feature clause names it is recommended that you pick one from the standard ones, but it is also possible to create a new one. If you have introduced a special feature clause name in your project, add it to the feature clause order list in the [[Preferences Reference|preferences]] and it will also appear in this dialog.
|
For feature clause names it is recommended that you pick one from the standard ones, but it is also possible to create a new one. If you have introduced a special feature clause name in your project, add it to the feature clause order list in the [[Preferences Reference|preferences]] and it will also appear in this dialog. <br/>
|
||||||
[[Image:feature-wizard-clausenames]]
|
[[Image:feature-wizard-clausenames]]
|
||||||
|
|
||||||
==Generated code==
|
==Generated code==
|
||||||
The code that is inserted in your class as a result of the selections made for the feature clause, is of the form:
|
The code that is inserted in your class as a result of the selections made for the feature clause, is of the form: <br/>
|
||||||
<code>feature {EXPORT} -- Clause name</code>
|
<code>feature {EXPORT} -- Clause name</code><br/>
|
||||||
except if you specified <eiffel>ANY</eiffel> as export status, which is similar to having no export status.
|
except if you specified <eiffel>ANY</eiffel> as export status, which is similar to having no export status. <br/>
|
||||||
<code>feature --Clause name</code>
|
<code>feature --Clause name</code>
|
||||||
<br/>
|
<br/>
|
||||||
For example, if you specified a the "Initialization" feature clause name, and specified <eiffel>NONE</eiffel> as export status, you get:
|
For example, if you specified a the "Initialization" feature clause name, and specified <eiffel>NONE</eiffel> as export status, you get: <br/>
|
||||||
<code>feature {NONE} -- Initialization</code>
|
<code>feature {NONE} -- Initialization</code>
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,18 +1,5 @@
|
|||||||
[[Property:title|New feature dialog: feature properties modification]]
|
[[Property:title|New feature dialog: feature properties modification]]
|
||||||
[[Property:weight|5]]
|
[[Property:weight|5]]
|
||||||
[[Property:uuid|60825ef4-7bc2-d472-8b09-25769689bb34]]
|
[[Property:uuid|60825ef4-7bc2-d472-8b09-25769689bb34]]
|
||||||
* [[Feature clauses|Feature clauses]]
|
|
||||||
* [[Name field|Name field]]
|
|
||||||
* [[Argument list|Argument list]]
|
|
||||||
* [[Header comment|Header comment]]
|
|
||||||
* [[Precondition|Precondition]]
|
|
||||||
* [[Local variable|Local variable]]
|
|
||||||
* [[Feature body|Feature body]]
|
|
||||||
* [[Postcondition|Postcondition]]
|
|
||||||
* [[Type selection|Type selection]]
|
|
||||||
* [[Invariant field|Invariant]]
|
|
||||||
* [[Set-procedure|Set-procedure]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -14,7 +14,9 @@ When clicking '''Function''', the dialog changes to the function layout. It has
|
|||||||
* [[Postcondition|Postcondition field]]
|
* [[Postcondition|Postcondition field]]
|
||||||
|
|
||||||
==Example==
|
==Example==
|
||||||
<div> [[Image:feature-wizard-function-example]] </div>
|
This dialog box:<br/>
|
||||||
|
<div> [[Image:feature-wizard-function-example]] </div><br/>
|
||||||
|
Produces this feature:<br/>
|
||||||
<code>class
|
<code>class
|
||||||
PRODUCT
|
PRODUCT
|
||||||
|
|
||||||
|
|||||||
@@ -13,7 +13,10 @@ When clicking '''Procedure''', the window changes to the procedure layout. It ha
|
|||||||
* [[Postcondition|Postcondition field]]
|
* [[Postcondition|Postcondition field]]
|
||||||
|
|
||||||
==Example==
|
==Example==
|
||||||
<div> [[Image:feature-wizard-procedure-example]] </div>
|
|
||||||
|
This dialog box:<br/>
|
||||||
|
<div> [[Image:feature-wizard-procedure-example]] </div><br/>
|
||||||
|
Produces this feature:<br/>
|
||||||
<code>class
|
<code>class
|
||||||
PRODUCT
|
PRODUCT
|
||||||
|
|
||||||
|
|||||||
@@ -41,8 +41,6 @@ generates_leading_underscore: no
|
|||||||
As in Eiffel, -- introduces a comment, which has no effect on the specification. If one of the xxx_column options has a value of 0, this means that the files generated by the given profiler contain no such column. The order of the options is not significant.
|
As in Eiffel, -- introduces a comment, which has no effect on the specification. If one of the xxx_column options has a value of 0, this means that the files generated by the given profiler contain no such column. The order of the options is not significant.
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
|
||||||
{{seealso|<br/>
|
{{seealso|<br/>
|
||||||
[[Select a Run-time information record to generate the Execution Profile|Select a Run-time information record to generate the Execution Profile]] <br/>
|
[[Select a Run-time information record to generate the Execution Profile|Select a Run-time information record to generate the Execution Profile]] <br/>
|
||||||
[[Profiling|How to profile a system]] }}
|
[[Profiling|How to profile a system]] }}
|
||||||
|
|||||||
@@ -1,8 +1,5 @@
|
|||||||
[[Property:title|Profiler How To's]]
|
[[Property:title|Profiler How To's]]
|
||||||
[[Property:weight|2]]
|
[[Property:weight|2]]
|
||||||
[[Property:uuid|f488bd8f-6d05-0487-a4c6-2e26a9a185ad]]
|
[[Property:uuid|f488bd8f-6d05-0487-a4c6-2e26a9a185ad]]
|
||||||
* [[How to set up a Profiler Configuration File|How to setup a Profiler Configuration File]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,14 +1,5 @@
|
|||||||
[[Property:title|Conventions]]
|
[[Property:title|Conventions]]
|
||||||
[[Property:weight|1]]
|
[[Property:weight|1]]
|
||||||
[[Property:uuid|1f101597-06cd-b851-8cc1-e214b3eedb3e]]
|
[[Property:uuid|1f101597-06cd-b851-8cc1-e214b3eedb3e]]
|
||||||
* [[Eiffel for .NET Conventions|Introduction]]
|
|
||||||
* [[Eiffel for .NET Terminology|Terminology]]
|
|
||||||
* [[Eiffel Class and Feature Names|Conventions and Name Handling]]
|
|
||||||
* [[Type Organization|Type Organization]]
|
|
||||||
* [[Constructors and Creation Procedures|Constructors and Creation Procedures]]
|
|
||||||
* [[Similar Types Occurring in Both Libraries|Similar Types Occurring in Both Libraries]]
|
|
||||||
* [[Eiffel Reserved Keywords|Eiffel Language Reserved Keywords]]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user