mirror of
https://github.com/EiffelSoftware/eiffel-org.git
synced 2025-12-08 07:42:33 +01:00
Author:halw
Date:2011-10-05T20:34:16.000000Z git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@982 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
@@ -143,23 +143,34 @@ By selecting certain options on the '''ec''' command, you can generate advanced
|
||||
|
||||
To see the "flat" form of class <code>APPLICATION</code> in the example used above:
|
||||
|
||||
<code>
|
||||
<code lang="text">
|
||||
ec -flat application -config application.ecf
|
||||
</code>
|
||||
|
||||
To save the output, add the "-file" option with a file name:
|
||||
|
||||
<code>
|
||||
<code lang="text">
|
||||
ec -flat application -config application.ecf -file application_flat_form.txt
|
||||
</code>
|
||||
|
||||
Feature-oriented options, like "-implementers", take a class name and feature name:
|
||||
|
||||
<code>
|
||||
<code lang="text">
|
||||
ec -implementers application some_feature -config application.ecf
|
||||
</code>
|
||||
|
||||
|
||||
===Commands for generating documentation===
|
||||
|
||||
You can use a variations of the viewing commands to generate documentation much like [[Producing and Exporting Documentation|you can from EiffelStudio]].
|
||||
|
||||
The following command will produce the Chart, Relations, and Text documentation for the "application" system in stylesheet html format in the "Documentation" subfolder of the project folder.
|
||||
|
||||
<code lang="text">
|
||||
ec -filter html-stylesheet -all -config application.ecf
|
||||
</code>
|
||||
|
||||
|
||||
==Command options==
|
||||
|
||||
The table below lists the available ''options'', the arguments they require, and their effect:
|
||||
@@ -259,7 +270,7 @@ The table below lists the available ''options'', the arguments they require, and
|
||||
|-
|
||||
| -filter
|
||||
| filter_file_name
|
||||
| Print text as processed by the [[Appendix: Writing Documentation Filters with EFF, the Eiffel Filter Format|filter]] defined in the file named ''filter_file_name''.
|
||||
| Print text as processed by the [[Appendix: Writing Documentation Filters with EFF, the Eiffel Filter Format|filter]] defined in the file named "''filter_file_name''.fil"
|
||||
|-
|
||||
| -help
|
||||
|
|
||||
@@ -293,6 +304,10 @@ The table below lists the available ''options'', the arguments they require, and
|
||||
|
|
||||
| Stop on errors. (Default: no.)
|
||||
|-
|
||||
| -target
|
||||
| target_name
|
||||
| Act on the system target named ''target_name''.
|
||||
|-
|
||||
| -use_settings
|
||||
|
|
||||
| Use the project global settings to retrieve the project location for the last compilation of this project.
|
||||
|
||||
Reference in New Issue
Block a user