[Openlaszlo] @type tag for methods

Feature requests
Post Reply
pal
Posts: 25
Joined: Fri Jun 15, 2007 8:06 am

[Openlaszlo] @type tag for methods

Post by pal » Tue Oct 07, 2008 4:38 pm

Hi there once again,

Eric, do you think an @type tag in comments for methods was possible? I.e. I've got a method:

Code: Select all

<method name="test" args="aBut, aText">
//some code
</method>
Now I've want to say 'aBut' is of type lz.button and 'aText' is of type string. And the whole thing returns a lz.view object.

Thanks for reading.
Cheers!

eric_suen
Site Admin
Posts: 678
Joined: Wed Sep 28, 2005 7:00 am
Contact:

Post by eric_suen » Wed Oct 08, 2008 6:08 am

Hi,

I have create a quick fix, download http://www.agpad.com/downloads/com.spke ... 1.6.15.jar and replace the old one, and the code should look like this

Code: Select all

<!---
@param button aaa: comment.
@return button: comment
-->
<method name="getname" args="aaa, bbb">
//some code
</method>

pal
Posts: 25
Joined: Fri Jun 15, 2007 8:06 am

Post by pal » Wed Oct 08, 2008 10:03 am

Wow ... that was really fast (once again).
Works perfectly. Thanks a lot. :D

Now I've got yet another request.
To get proper documentation for my methods I've got to append a <br> tag to each line in the comments. Maybe it was possible to break the line in the docs too when i do a linebreak. But on the other hand that might be on purpose to beeing able to not linebreak. So maybe just do a linebreak when @param or @return occures?

eric_suen
Site Admin
Posts: 678
Joined: Wed Sep 28, 2005 7:00 am
Contact:

Post by eric_suen » Wed Oct 08, 2008 11:43 am

You means the comment shows in info view and document view?

pal
Posts: 25
Joined: Fri Jun 15, 2007 8:06 am

Post by pal » Wed Oct 08, 2008 6:43 pm

Yes, I'm talking about the text the appears in the document view. It displays the tags and the description. Whereas it's nice to have those parameter-descriptions in the document-view all those tags are in a single line there unless I put a html linebreak at the end of each line in the comments. If it was possible to break those tags it would be nice but it's not important.

eric_suen
Site Admin
Posts: 678
Joined: Wed Sep 28, 2005 7:00 am
Contact:

Post by eric_suen » Thu Oct 09, 2008 6:20 am

This bug has been fixed, please download http://www.agpad.com/downloads/com.spke ... 1.6.15.jar again.

pal
Posts: 25
Joined: Fri Jun 15, 2007 8:06 am

Post by pal » Thu Oct 09, 2008 11:06 am

Well, it wasn't a bug but a feature :wink:

Works fine on the tooltip you get by pressing f2:

Code: Select all

subviewcounter(subview)

counts all subviews this view contains excluding itself 
Parameters:
	view subview: the view to examine
Returns:
	number: the number of subviews
The documentation view however shows this for the same method:

Code: Select all

subviewcounter(subview)
counts all subviews this view contains excluding itself @param view subview: the view to examine @return number: the number of subviews

eric_suen
Site Admin
Posts: 678
Joined: Wed Sep 28, 2005 7:00 am
Contact:

Post by eric_suen » Thu Oct 09, 2008 12:23 pm


pal
Posts: 25
Joined: Fri Jun 15, 2007 8:06 am

Post by pal » Thu Oct 09, 2008 1:33 pm

Thanks a lot. Works.

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest