Skip to main content


Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » RCP Testing Tool » Java Doc with ECL procs (Formatting java documentation whith ECL proc.)
Java Doc with ECL procs [message #1783032] Tue, 06 March 2018 23:37 Go to next message
Bruce Edgerton is currently offline Bruce EdgertonFriend
Messages: 25
Registered: May 2017
Junior Member
I am adding java documentation to ECL proc libraries. For example:

// This selects an item from the manage offer stage dates table.
// <p><b>item</b> - A string, the item to be selected.
proc "select-date-item" [val item] {
	get-table | select $item | double-click
}


When I hover over a proc call, the java doc is displayed as follows:

Procedure select-date-item
This selects an item from the manage offer stage dates table.

item - A string, the item to be selected.

Arguments:
item

Defined in:

Is there any way to add the argument text to the Arguments: section? I have looked all over the place and haven't been able to find a solution.

[Updated on: Tue, 06 March 2018 23:55]

Report message to a moderator

Re: Java Doc with ECL procs [message #1783329 is a reply to message #1783032] Mon, 12 March 2018 06:58 Go to previous messageGo to next message
Viktoria Dlugopolskaya is currently offline Viktoria DlugopolskayaFriend
Messages: 124
Registered: March 2017
Senior Member
Hi Bruce,

Unfortunately, providing a description for procedure arguments is not supported. The argument description may content only 'optional' property and default value.
Re: Java Doc with ECL procs [message #1783648 is a reply to message #1783329] Thu, 15 March 2018 01:07 Go to previous message
Bruce Edgerton is currently offline Bruce EdgertonFriend
Messages: 25
Registered: May 2017
Junior Member
Ok, thanks Viktoria. Could I put in a request for such a feature? Something like:

// This selects an item from the manage offer stage dates table.
// @param item - A string, the item to be selected.
proc "select-date-item" [val item] {
	get-table | select $item | double-click
}


Hovering over a statement using this proc would display:

Procedure: select-date-item
This selects an item from the manage offer stage dates table.

Arguments
item
- A string, the item to be selected.
Previous Topic:Java Heap Size - Out of Memory
Next Topic:How to verify a text on Console View
Goto Forum:
  


Current Time: Fri Oct 19 04:16:21 GMT 2018

Powered by FUDForum. Page generated in 0.02997 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software

Back to the top