I trying to figure out how Godot documentation comments are working.
I apply them in my code, but I don't see any hints in a code editor, or in property-inspector.
Where it should be shown? How can I see these hints?
And related subquestion is there a way to document function parameters?
Godot documentation comments :
"If an exported variable is documented, its description is used as a tooltip in the editor. This documentation can be generated as XML files by the editor."
But export keyword already in use, or do I get it wrong?
And there is no information about how to document function parameters.
The documentation you are looking at is for Godot 4.0. Comment documentation is a Godot 4.0 feature, and does not work in Godot 3.x. I suspect you are using Godot 3.x given that you say:
export keyword already in use
In Godot 4.0 export is no longer keyword. Instead, it is an annotation.
About documenting parameters, Godot does not generate per parameter documentation. See the method descriptions for any class that Godot provides to see what I mean.
Also #desc and #tutorial are the only supported tags in Godot 4.0 source at the time of writing. Instead explain to the parameters in the description. I believe the convention is to place the parameter name between [code] and [/code]. To reiterate, this is a Godot 4.0 feature.
Related
I'm new in xpages development and I'm facing this issue.
I have installed the updateSiteOpenNTF-designer.zip from ExtensionLibraryOpenNTF-901v00_13.20150611-0803 release.
When working on xpage in the source view I'm getting only <xp:this...> tags as suggestions via Content assist.
But it would be much helpful to have all possible <xp:..> tags included in the Content assist, like '', <xp:eventHandler...>, etc.
Within the Extension library there is documentation with all these possible tags in html format. My question is:
is there a way to transform this documentation into another format (i guess xml) and included it somehow into Content assist of Domino Designer?
I'm using Domino Designer 9.0 which is based on Eclipse.
Thank you very much for any useful answer.
See this question Is there a DTD for XPage source?.
To elaborate, the xp:... tags are core components, not part of the Extension Library. Those tags all start xe:.... It will probably need some kind of xml schema documentation to be created and for you to point to. I did something similar for themes https://github.com/paulswithers/xpages_theme_dtd. Creating the schema for that was not particularly challenging, but there will be more elements and attributes for this. I don't believe anyone has created a schema up until now, and I don't think it's something that can be auto-created from Javadoc documentation (which is available on the web).
Once available, you might need to remove the dtd specification at the top before compiling, as you do for themes.
As I have asked questions in this form - thanks for your many helpful answers - i have found many really neat things that one can do using ExtLibUtil.???? however, other than a bit here and a bit there I have not found anything that gives a listing on the various functions. I one post I read that it is all in the source of the extension Library, and it might be if you really understand where in the source to look. Sure would appreciate a pointer and starting point.
I've been unable to find a JavaDoc for it. The library slipped passed us when we wrote the book - certainly I was not as au fait with Java to be aware of it and all the strength within it. So the best option currently is to look at the source code in Eclipse. Many of the methods are helper methods to easily access things like viewScope etc, which is easy from SSJS but less easy from Java. Most are pretty self-explanatory.
Content assist doesn't seem to work from SSJS, but will from any Java class or, alternatively, open up one of the Java classes created for XPages / Custom Controls under the "local" package in Package Explorer, type "ExtLibUtil." in any method and you'll see the list.
I want to add a new section in control panel of liferay and within that section I want to have my custom-portlet. I did it using ext. However I want to do it with hook . Is it possible ?
I don't think it would be that easy with a hook, because of the following reasons:
You can't modify in a Hook - the class com.liferay.portal.util.PortletCategoryKeys which contains the keys for displaying the different sections. The different sections are hard-coded in this class in a String array ALL.
You can't modify the logic of PortalImpl#isControlPanelPortlet() which uses the PortletCategoryKeys#ALL to determine if the request in question is for a control panel portlet.
Then you also have another method which you can't modify with a Hook and is used extensively PortalImpl#getControlPanelCategory()
Doing it with a hook:
I have not tried this but I think if you need to do it with a hook you would have to change all those JSPs which make use of PortletCategoryKeys#ALL and the methods of PortalImpl as stated above, and provide your custom implementation for all these methods in the JSP.
I would really like to know how you implemented it with an EXT may be just the steps or the methods you have overridden. So that I can try to convert those in terms of a hook.
This is as far as my understanding goes. Hope this helps.
With the advent of Marketplace, ControlPanel has a new category named "Marketplace" and that section is introduced in a plugin. However, I never checked if 6.1 GA2 introduced a new section that this plugin just fills. Check the marketplace plugin if you can find a trace of this section implemented there.
On the other hand, nobody has yet named any section that definitely required a new section (though some have asked me how to solve the same problem). For this reason, you might want to re-think the requirement and choose one of the existing sections. If you don't, at least I'd be interested in the name and purpose of the new section - I might find a first one actually justifying this kind of implementation...
Can anyone tell me where com.ibm.xsp.component.UIIncludeComposite is documented? I searched in the help file for UIIncludeComposite but found nothing.
There is only one brief mention of it in Mastering xPages.
com.ibm.xsp.component.UIIncludeComposite is the class for the object returned by getComponent when calling getComponent for a custom control.
In fact where is anything documented? I think the single biggest frustration as a newbie xPage programmer is the lack of documentation or where to find it.
The Java class is documented in the Javadoc available at http://www-10.lotus.com/ldd/ddwiki.nsf/dx/Domino_Designer_Extensibility_APIs_Javadoc_8.5.3 which points to this page for the specific class:
http://public.dhe.ibm.com/software/dw/lotus/Domino-Designer/JavaDocs/DesignerAPIs/com/ibm/xsp/component/UIIncludeComposite.html
General documentation for Upgrade Pack 1 and Extension Library is available here:
http://www-10.lotus.com/ldd/ddwiki.nsf/xpViewCategories.xsp?lookupName=Domino%20Designer%20XPages%20Extension%20Library
Especially rich:autocomplete. There are a lot of possible attributes but not all of them are explained, neither in the Developers Guide nor in the Component Reference. For example there is no information about fetchValue, immediate, selecteditemClass,...
You need to check the Tag Library Documentation. Here is the <rich:autocomplete>.