mirrors/eiffel-org
1
0
Fork 0
mirror of https://github.com/EiffelSoftware/eiffel-org.git synced 2025-12-07 07:12:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated to upcoming 23.09

Browse Source 
git-svn-id: https://svn.eiffel.com/eiffel-org/trunk@2393 abb3cda0-5349-4a8f-a601-0c33ac3a8c38
This commit is contained in:
eifops
2023-09-25 09:13:12 +00:00
parent 246745930d
commit e2bb303f94
2975 changed files with 63910 additions and 342 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
documentation/23.09/eiffelstudio/eiffelstudio-how-tos/generating-documentation/generating-multi-format-documentation.wiki Normal file
View File

@@ -0,0 +1,49 @@
[[Property:title|Generating multi-format documentation]]
[[Property:weight|0]]
[[Property:uuid|37a81bfb-004f-a1f9-7cc8-140639e96e9f]]
EiffelStudio can generate documentation for a system using many different formats.
The '''Documentation Wizard''', which helps you to get the documentation you want, is available in the '''Project''' menu, under the entry '''Generate Documentation'''.
The first page of the Documentation Wizard lets you choose between the available formats for the documentation:
[[Image:index-37]]
{{tip|The nicest output is produced by the '''html-stylesheet''' format. }}
Now the wizard asks you to select the clusters you want to produce documentation for:
[[Image:index-38]]
In the next page you can specify indexing items on which HTML metatags will be based:
[[Image:index-39]]
{{note|This page is only available for HTML documentation. }}
You can then pick the formats you need among those available. For example, you might need a file containing the '''Cluster hierarchy''' of your system or, for each class, a file containing the '''Contracts''' of that class. At this point you can also decide to generate BON diagrams for the clusters selected in the previous page.
[[Image:index-40]]
If you have checked '''Cluster diagrams''' in the previous page, you will now be able to choose a view for each diagram that is going to be generated. You have the choice between an automatically arranged view and all of the [[Views|views ]] you may have manually arranged with the [[Diagram tool|Diagram Tool]] .
[[Image:index-41]]
{{note|Cluster diagrams are only available for HTML documentation. }}
Here comes the last page; you can choose the directory where the documentation is going to be generated:
[[Image:index-42]]
{{seealso|<br/>
[[Generating XMI documentation|Generating XMI documentation]] }}

22
documentation/23.09/eiffelstudio/eiffelstudio-how-tos/generating-documentation/generating-xmi-documentation.wiki Normal file
View File

@@ -0,0 +1,22 @@
[[Property:title|Generating XMI documentation]]
[[Property:weight|1]]
[[Property:uuid|a6aa8b26-6ce4-90d5-7204-014c5fee0267]]
EiffelStudio can generate an '''XMI''' description of a system; '''XMI''' (XML Metadata Interchange) format is the new industry standard way to describe and exchange object-oriented systems, further information can be found [http://www.omg.org/technology/xml/ here] .
The '''XMI Export wizard''' is available in the '''Project''' menu, under the entry '''Export XMI'''.
The first page of the wizard lets you select the clusters you want to produce documentation for:
[[Image:xmi-wizard-cluster-selection]]
On the second and last page, you can choose the directory where the XML file is going to be generated:
[[Image:xmi-wizard-path-selection]]
{{seealso|<br/>
[[Generating multi-format documentation|Generating multi-format documentation]] }}

5
documentation/23.09/eiffelstudio/eiffelstudio-how-tos/generating-documentation/index.wiki Normal file
View File

@@ -0,0 +1,5 @@
[[Property:title|Generating documentation]]
[[Property:weight|7]]
[[Property:uuid|18c19156-899a-33fd-92f0-3065267f30f0]]