Commit 37a32806 authored by Adam Knapp's avatar Adam Knapp
Browse files

Some formatting improvements of documents


Signed-off-by: Adam Knapp's avatarAdam Knapp <adam.knapp@ericsson.com>
parent 13634b93
......@@ -145,8 +145,10 @@ If enabled, a popup window is shown when hovering over different elements of the
* **Hover window content**
+
The content of the popup window can be specified by this preference. This option can be directly changed using the shortcut button of the hover window (see <<hover-window-content,the figure below>>). Two types are implemented:
* code comment and info: relevant information is shown based on the documentation comments (if available) and the semantic information related to the selected part of the source code.
* code peek: the definition of the selected code part is shown in the popup window.
** code comment and info: relevant information is shown based on the documentation comments (if available) and the semantic information related to the selected part of the source code.
** code peek: the definition of the selected code part is shown in the popup window.
[[hover-window-content]]
......
......@@ -246,11 +246,17 @@ The proposals are ordered in the following way (definitions don’t hide each ot
. Keywords available. The keywords are ordered alphabetically.
As an experimental feature, the content assistant is made context-aware in some cases meaning that it lists more relevant proposals based on the context where it was initiated. The following cases are handled (not a complete list):
* list of modules after `import from` and `friend` keywords;
* list of component types after `runs on` and `system` keywords;
* list of matching/compatible type of elements from the visible scope for the right side of an assignment;
* list of matching/compatible type of elements from the visible scope for a function parameter;
* list of the enumerated items of the matching type for the right side of an assignment;
* documentation comment tags when editing documentation comment section.
When this context-aware content assist is invoked, it also provides the documentation comments (if available) related to the selected proposal.
......@@ -264,6 +270,7 @@ Only data gathered and stored by the on-the-fly parsers can be offered. If this
== Documentation comments
Documentation comments are supported according to <<_12, TTCN-3 Documentation Comment Specification>> and also available for extending the capabilities of some IDE features. Beside having a brief description in the code about the commented language element, the documentation comments are parsed and able to assist the users who are writing or browsing the code through integrating the documentation comments in some standard IDE features. The documentation comments are integrated into the following IDE functions:
* Code hover popups: when hovering over certain language elements, a popup window appears containing the related and parsed documentation comment. The documentation comments are completed with relevant semantical information, e.g. with the types of the formal parameters of a function. An example of this feature is presented in the figure below. The content of this popup window can be changed to peek the definition of that language element (for details see <<peek-declaration,Peek declaration>>). To enable this feature see the <<content-assist,Content Assist Preferences>>.
image::images/7_doc_comment_hover_example.png[title="Documentation comments usage during hovering"]
......@@ -273,12 +280,15 @@ image::images/7_doc_comment_hover_example.png[title="Documentation comments usag
image::images/7_doc_comment_code_assist_example.png[title="Documentation comments usage during code assist"]
* Semantic information and documentation comments consistency checks: it is intentionally left a big user freedom to write basically anything in the documentation comment section of the code, however, there are several validation mechanisms available to notify the users about possible problems with the code and/or with the documentation comment. The severity of these problems is configurable (see <<errors-warnings-preferences, Errors / Warnings Preferences>>). The comment tags are validated against the language element to which they are related, e.g. the `@verdict` tag is marked if it used in documentation comment of a type definition. Also, the related comments of the formal parameter lists are also checked against the definition, e.g. the number of the documented parameters differ from the related function definition, etc.
* Code highlight: the specification recommends to use the `@status` tag for describing the actual status of the object. If the deprecated status (`@status deprecated`) is used, the highlight of the relevant code parts is changed according to the configured style (the semantic highlighting preference must be enabled, see <<syntax-coloring-preferences, Syntax Coloring Preferences>>).
To have the listed functions, the on-the-fly checking of document comments preference must be enabled (see <<on-the-fly-checker-preferences,On-the-fly Checker Preferences>>) beside the function specific configuration.
Additional features:
* the `@url` tag is automatically converted to a link.
* HTML tags are allowed in the documentation comments. Actually, the popup windows work as simple web browsers, thus complete pages or PDF documents can also be shown.
=== Generate documentation comment
......
......@@ -103,8 +103,8 @@ image::images/7_F47.png[title="Export wizard for JAR file"]
The following options are available:
* *Launch Configuration*: select the launch configuration that configures the execution for this JAR file. This will set the class to be used for execution, i.e. the main class defined by the selected launch configuration will be the default entry point of the exported JAR file.
* NOTE: Only launch configurations of Java application type are available for selection here. If such configuration is not created previously, you have to create one to continue.
+
NOTE: Only launch configurations of Java application type are available for selection here. If such configuration is not created previously, you have to create one to continue.
* *Export destination*: select the file into which the export should be done.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment