Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [orion-dev] CodeEdit - contentassist proposal

Further refining my question, here is the example _javascript_ code. Orion automatically parses this code and prompts code-complete options with the function description and the param type etc. My question is how can I accomplish the same using the "orion.edit.contentassist" provider. What is the structure to push JSDoc style metadata?

var fm2 = {
/** Read value of a field
* {@link www.myapp.com/fn=fm2get|Online Documentation}
*
* @param {string} field_name - field name
* @return {string} field value
*/
get:function(field_name){
},
/** Set value to a field
* {@link www.myapp.com/fn=fm2set|Online Documentation}
*
* @param {string} field_name - field name
* @param {string} field_value - field value
*/
set:function(field_name, field_value){
}
} ;

fm2.<type CTLR+SPACE>


Thanks

Gowrishankar Holalkere | Sr. Development Manager, IT
Solutions Development - Variable Data Management
Retail Branding and Information Solutions | Avery Dennison 
1700 West Park Drive, Suite 400, Westborough, MA 01581
508-948-3466 (office) | 508-308-7987 (mobile) 
Gowrishankar.Holalkere@xxxxxxxxxxxxxxxxx 


On Wed, Dec 2, 2015 at 2:13 PM, Gowrishankar Holalkere <gowrishankar.holalkere@xxxxxxxxxxxxxxxxx> wrote:
Hello,
I have tried registering custom content assist options based on the example in the howto page under codeEdit.serviceRegistry section. I am able to see my assist options when I key-in [CTRL][SPACE]. However, the content displayed is minimal. It does not display the help-description div on the right side. 

I suspect this is to do with the metadata registered for the option. Could you please publish an example of registering a function which shows all the details similar to str.charAt(). On the left-side panel, it shows "charAt(i): String" and on the right-side panel, it shows 

Returns the specified character from a string.
Online documentation (hyper-link)



Thanks

Gowrishankar Holalkere | Sr. Development Manager, IT
Solutions Development - Variable Data Management
Retail Branding and Information Solutions | Avery Dennison 
1700 West Park Drive, Suite 400, Westborough, MA 01581
508-948-3466 (office) | 508-308-7987 (mobile) 
Gowrishankar.Holalkere@xxxxxxxxxxxxxxxxx 




-------------------------------------------------------------------------------------------------------------
The information transmitted is intended only for the person or entity to which it is addressed and may contain confidential and/or privileged material. Any review, retransmission, dissemination or other use of, or taking of any action in reliance upon, this information by persons or entities other than the intended recipient is prohibited. If you received this in error, please contact the sender and delete the material from any computer.
-------------------------------------------------------------------------------------------------------------


Back to the top