Skip to content

Commit ae2a055

Browse files
author
Frédéric Ferran
committed
Some corrections in the documentation.
1 parent 25d2b44 commit ae2a055

File tree

117 files changed

+795
-522
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+795
-522
lines changed

JavaDesigner/src/main/doc/adoc/Classpath_and_external_classes.adoc

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[Project-classpath-types-not-found-and-external-classes]]
29

310
[[project-classpath-types-not-found-and-external-classes]]
@@ -10,7 +17,7 @@
1017

1118
Usually a java project is composed of its own model and source files. During a reverse operation (or a round trip mode update), all those files are considered accessible: links are always created in the model to the corresponding classes.
1219

13-
*_Note:_* Each << Java Component >> can define its own source path, meaning a java project can use several source directories at the same time.
20+
*Note:* Each «Java Component» can define its own source path, meaning a java project can use several source directories at the same time.
1421

1522
[[Defining-classpath]]
1623

@@ -19,9 +26,9 @@ Usually a java project is composed of its own model and source files. During a r
1926

2027
Sometimes, other elements are needed, which are essential to the project but do not actually belong to it. They usually correspond to external libraries (Jar files), or some other parts of the project not yet in the model.
2128

22-
All used JAR files must be declared in the project configuration. To define them, launch the Java Designer/Configuration/Edit accessible classes command on the project’s root package.
29+
All used JAR files must be declared in the project configuration. To define them, launch the "Java Designer/Configuration/Edit accessible classes" command on the project’s root package.
2330

24-
image:images/Classpath_and_external_classes_Menu_146.png[image]
31+
image::images/Classpath_and_external_classes_Menu_146.png[image]
2532

2633
[[Type-reverse]]
2734

@@ -31,14 +38,14 @@ image:images/Classpath_and_external_classes_Menu_146.png[image]
3138
When a reference to a type (extends link, parameter…) is found and needs to be reversed, Java Designer goes through several steps:
3239

3340
* Is this java type accessible in the project sources (.java) or in the configuration (.jar)?
34-
** Not found means the type *won’t be searched in the model*: all references are replaced by tagged values, making the model partially inaccurate. The configuration may need to be completed, or the model to be generated. A Type not found warning is also added to the report.
41+
** Not found means the type *won’t be searched in the model*: all references are replaced by tagged values, making the model partially inaccurate. The configuration may need to be completed, or the model to be generated. A "Type not found" warning is also added to the report.
3542
** Type found in accessible classes, search in the model.
3643
* Is this type found in the model?
3744
** Yes, update its content.
3845
** Not found in the model, it will be created. Is this type part of the files to reverse?
3946
*** Yes, type is created in the model with all its content.
40-
*** No, type is created in the model as an External element. An External element creation warning is also added to the report.
47+
*** No, type is created in the model as an "External element". An "External element creation" warning is also added to the report.
4148

42-
*_Note:_* An External Element is an empty placeholder. It is recommended either to update it, or to use a Model Component that contains it. The Java code of an external element is never generated.
49+
*Note:* An "External Element" is an empty placeholder. It is recommended either to update it, or to use a Model Component that contains it. The Java code of an external element is never generated.
4350

4451
[[footer]]

JavaDesigner/src/main/doc/adoc/Index.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[Modelio-Java-Designer-User-Guide]]
29

310
[[modelio-java-designer-user-guide]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_1.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Introduction-topic]]
29

310
[[the-introduction-topic]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Functionalities-topic]]
29

310
[[the-functionalities-topic]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2_1.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Generating-Java-Code-chapter]]
29

310
[[the-generating-java-code-chapter]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2_2.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Java-Documentation-Generation-chapter]]
29

310
[[the-java-documentation-generation-chapter]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2_3.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-ANT-Generation-chapter]]
29

310
[[the-ant-generation-chapter]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2_4.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Java-Reverse-chapter]]
29

310
[[the-java-reverse-chapter]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2_5.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Choosing-Your-Functional-Mode-chapter]]
29

310
[[the-choosing-your-functional-mode-chapter]]

JavaDesigner/src/main/doc/adoc/Javadesigner-_java_files_java_2_6.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
// Disable all captions for figures.
2+
:!figure-caption:
3+
4+
// Hightlight code source and add the line number
5+
:source-highlighter: coderay
6+
:coderay-linenums-mode: table
7+
18
[[The-Java-Automation-chapter]]
29

310
[[the-java-automation-chapter]]

0 commit comments

Comments
 (0)