GEDI

[Ulrich Ahrens]

Hello,

It is possible, to use the tool: "Insert function documetation" in panel scripts?
The tool is avaible in libs, but not in panel scripts?
The view "function list" to insert documentation is in panels not avaible?

And its the documentation headers ect. configurable (e.g. used DoxyGen tags for documentation)?

Mfg

[dbindernagel]

1.
The command "Insert Function Documentation" in the tools menu is also available in panel scripts (tested in 3.14, 3.15 and 3.16).

2.
The "function list" can be opened by using a right click somewhere on the menu bar of the opened script editor and select "Functions".
But this view is not needed to use the "Insert Function Documentation" command. Maybe I'm getting something wrong here?

3.
I do not know if the existing command is configurable but it is possible to extend the Gedi and the script editor with own menus and commands.
You could therefore write your own command for inserting a function documentation tailored to your needs.
See the help file for more information here:
"Graphics editor (GEDI)\\Expandability of GEDI\\GEDI menu and toolbar"
"Graphics editor (GEDI)\\The Script Editor\\Script Editor Extensions"

[Ulrich Ahrens]

1. Is this command avaible for Panel in XML Format too?
We use the XML Panel format becaus is it better to merge this fileformat by differences.

2. See Point 1, i have this function not seen by Panel XML Type.

3. I am would be append additional DoxyGen Tags and so on

[mkoller]

I assume you mean: when using the script editor in the "Edit panel scripts" mode (where ALL scripts are shown in ONE script editor), then you're right, it seems the "insert docu" tool is not working. This is a bug.
"The view "function list" is not available in this mode as well, since most functions are "main" functions, so it would not help much.
The Script Editor functionality has nothing to do with the panel format (PNL, XML) you select.
You can always use the Script Editor started from the Attribute Editor (Events List) where you then see just the single script for a specific event or also for the Panel Scope Library,
which would be basically the only script of a panel where function documentation makes sense, since all other scripts usually do not contain more than the main() function.

[Ulrich Ahrens]

Yes, exactly. Too bad it does not work, it would be a good feature in my opinion.

[n.kuehl]

Hello, does anyone know where I can configure the automatic generated keys (like @param ...) at the "insert function documentation" tool?
For me it displays only the @param and @return (without datatype), but I also want the @author and @name key.

[leoknipp]

Did you have a look at the WinCC OA Documentation and the chapter "High Speed Programming"?

Best Regards
Leopold Knipp
Senior Support Specialist

[gschijndel]

The "Insert Function Documentation" is NOT part of the "High Speed Programming", but built into the script editor. So unfortunately the inserted function header is fixed.