TIP: How to show the documentation of a deprecated call.

Questions and answers regarding the use of eclipse environment as seen in Servoy Developer

TIP: How to show the documentation of a deprecated call.

Postby jcompagner » Wed Jun 06, 2012 10:47 am

In Servoy 6.1 we have documented many deprecated methods so that you know what to use or call instead of this deprecated method.
Problem is that if deprecation is also a builder marker (error/warning) then you will see the documentation of the problem, not the doc of the method/field itself.

In 6.1 we have made a default modifier to the hover, that will show you the doc, and that is ALT, so when pressing the ALT key and hover over the call, it will show you the documentation and then also the @deprecated tag with a description what to use.
If you see things that don't have a nice description behind the deprecation tag, please make a case so that we can improve that doc.

In 6.0 you can also get that same behavior by going into the preferences of the developer, then Javascript -> Editor -> Hover. Here you can configure which hover you will see, when you press or don't press a modifier.
Johan Compagner
Servoy
User avatar
jcompagner
 
Posts: 8833
Joined: Tue May 27, 2003 7:26 pm
Location: The Internet

Re: TIP: How to show the documentation of a deprecated call.

Postby omar » Sun Jul 01, 2012 5:48 pm

I found this valuable tip in the unanswered posts section and would like to bring it under the attention again. Thx, J.
Intrasoft, Founder
Omar van Galen
omar@intrasoft.nl
+31-(0)6-21234586
Servoy Developer
omar
 
Posts: 377
Joined: Sat Feb 12, 2011 4:51 pm
Location: Intrasoft, The Netherlands

Re: TIP: How to show the documentation of a deprecated call.

Postby Kahuna » Fri Aug 10, 2012 9:52 am

jcompagner wrote:In 6.0 you can also get that same behavior by going into the preferences of the developer, then Javascript -> Editor -> Hover. Here you can configure which hover you will see, when you press or don't press a modifier.

Which aspects exactly should be checked in this hovers listing Johan - so far there is no combination we have found that shows the new code to replace deprecated code???

Appreciate your feedback.
(Servoy Version: 6.0.7 Win XP / 7 - SQL Server 2008 R2)
Ian Cordingley (Kahuna)
Kahuna
 
Posts: 1235
Joined: Thu Oct 26, 2006 1:39 am
Location: 1/2 NE UK 1/2 Olvera Spain

Re: TIP: How to show the documentation of a deprecated call.

Postby omar » Fri Aug 10, 2012 10:28 am

Here's an example:

deprecated.jpg
deprecated.jpg (36.13 KiB) Viewed 6737 times


Cheers,
Intrasoft, Founder
Omar van Galen
omar@intrasoft.nl
+31-(0)6-21234586
Servoy Developer
omar
 
Posts: 377
Joined: Sat Feb 12, 2011 4:51 pm
Location: Intrasoft, The Netherlands

Re: TIP: How to show the documentation of a deprecated call.

Postby Kahuna » Fri Aug 10, 2012 12:02 pm

omar wrote:Here's an example:

deprecated.jpg


Cheers,


Thais what I am hoping to see in 6.0x Omar. But I cant find any combination of the hover selections that show the new code. Thais is what I need - which selections to make to see it in this version?
(Servoy Version: 6.0.7 Win XP / 7 - SQL Server 2008 R2)
Ian Cordingley (Kahuna)
Kahuna
 
Posts: 1235
Joined: Thu Oct 26, 2006 1:39 am
Location: 1/2 NE UK 1/2 Olvera Spain

Re: TIP: How to show the documentation of a deprecated call.

Postby jcompagner » Fri Aug 10, 2012 12:14 pm

in 6.0 this also works if you preferences -> javascript -> editor->hovers
and then select/enable the documentation one, and give it the ALT modifier key
Then you can see the documentation of the deprecated functions when holding the old
Problem is that many docs of us don't have the deprecated doc that points to the one to use, that is what we fixed for 6.1 to have much better docs
Johan Compagner
Servoy
User avatar
jcompagner
 
Posts: 8833
Joined: Tue May 27, 2003 7:26 pm
Location: The Internet

Re: TIP: How to show the documentation of a deprecated call.

Postby Kahuna » Fri Aug 10, 2012 2:30 pm

jcompagner wrote:in 6.0 this also works if you preferences -> javascript -> editor->hovers
and then select/enable the documentation one, and give it the ALT modifier key
Then you can see the documentation of the deprecated functions when holding the old
Problem is that many docs of us don't have the deprecated doc that points to the one to use, that is what we fixed for 6.1 to have much better docs


I have that set already Johan - but there is no new code suggestion??
Attachments
CodeSupport.png
CodeSupport.png (9.59 KiB) Viewed 6713 times
Hovers.png
Hovers.png (12.48 KiB) Viewed 6713 times
(Servoy Version: 6.0.7 Win XP / 7 - SQL Server 2008 R2)
Ian Cordingley (Kahuna)
Kahuna
 
Posts: 1235
Joined: Thu Oct 26, 2006 1:39 am
Location: 1/2 NE UK 1/2 Olvera Spain

Re: TIP: How to show the documentation of a deprecated call.

Postby jcompagner » Fri Aug 10, 2012 2:37 pm

i did write: "Problem is that many docs of us don't have the deprecated doc that points to the one to use, that is what we fixed for 6.1 to have much better docs"

So now in 6.0 you won't see all the nice @deprecate tags telling you what to use now. We updated the doc in 6.1 for that.
Johan Compagner
Servoy
User avatar
jcompagner
 
Posts: 8833
Joined: Tue May 27, 2003 7:26 pm
Location: The Internet

Re: TIP: How to show the documentation of a deprecated call.

Postby Kahuna » Fri Aug 10, 2012 2:52 pm

jcompagner wrote:i did write: "Problem is that many docs of us don't have the deprecated doc that points to the one to use, that is what we fixed for 6.1 to have much better docs"

So now in 6.0 you won't see all the nice @deprecate tags telling you what to use now. We updated the doc in 6.1 for that.


OK - Thanks for that Johan - that wasn't clear to me when you suggested it was available in 6.0 too!

When will the next update for 6.1 be available? There are quite a few aspects of it (reported here) that would break our app, e.g. databaseManager.hasRecordChanges(). But we are really looking forward to getting to use the extra web enabled aspects of this new version (and of course the code enhancements such as this hover).

Ian
(Servoy Version: 6.0.7 Win XP / 7 - SQL Server 2008 R2)
Ian Cordingley (Kahuna)
Kahuna
 
Posts: 1235
Joined: Thu Oct 26, 2006 1:39 am
Location: 1/2 NE UK 1/2 Olvera Spain

Re: TIP: How to show the documentation of a deprecated call.

Postby jcompagner » Fri Aug 10, 2012 3:07 pm

in about +/-2 weeks is currently the plan.
Johan Compagner
Servoy
User avatar
jcompagner
 
Posts: 8833
Joined: Tue May 27, 2003 7:26 pm
Location: The Internet


Return to Eclipse Environment

Who is online

Users browsing this forum: No registered users and 4 guests