JSDoc description not displayed

Get help with Spket IDE.
Post Reply
EasonLin
Posts: 5
Joined: Tue Mar 06, 2012 3:55 am

JSDoc description not displayed

Post by EasonLin » Tue Mar 06, 2012 4:08 am

Hi,
I use Eclipse 3.6.2 Helios for JS. I have updated Spket plugin to 1.6.22 + FIX(found it in viewtopic.php?f=3&t=3619).
I have included both custom .js and ExtJs 4.0.7 jsb3 into javascript profiles.

I couldn't see the custom file's jsDoc description, but ExtJs could.

I tried to add include tag in the file header as below :

Code: Select all

/**
 * @include "custom.js"
 */
And the jsDoc description displaed well !
Is anything I miss or do incorrectly ?

Thank you very much !!

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

Re: JSDoc description not displayed

Post by eric_suen » Tue Mar 06, 2012 8:08 am

Is your custom.js override the Ext JS comment or it's the comment for your custom class? if it's the first case, then yes, it will not display the custom comment, because that fix only works for jQuery. if it's the 2nd case, maybe it's a bug, could you please give more information?

EasonLin
Posts: 5
Joined: Tue Mar 06, 2012 3:55 am

Re: JSDoc description not displayed

Post by EasonLin » Wed Mar 07, 2012 12:21 am

Sorry for the lack of infomation !!

In my case, it's 2nd one.
I tried to do a custom class in a file.
In this file, the jsDoc description works fine, but in other files, the code completion isn't displayed the jsDoc description.

Thanks for your help and fast reply !!

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

Re: JSDoc description not displayed

Post by eric_suen » Wed Mar 07, 2012 5:52 am

I tried and it works fine, what's your OS and encoding of the file? could you convert the encoding to UTF-8 and try again? or you could send me a simple test case. simple enough to reproduce the bug.

EasonLin
Posts: 5
Joined: Tue Mar 06, 2012 3:55 am

Re: JSDoc description not displayed

Post by EasonLin » Wed Mar 07, 2012 7:48 am

The OS is Win 7 64 Pro.
The encoding of this file is UTF8. I have tested both UTF8 and UTF8(without BOM). The description isn't displayed.

While I add the @include tag in front of the code, the description shows !
I don't know if there is something incorrectly I did.

I have mailed the test code to support@spket.com and hope it helps.

Thanks for your help !!

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

Re: JSDoc description not displayed

Post by eric_suen » Wed Mar 07, 2012 8:36 pm

Indeed their is a bug in common library, I uploaded a fix, please download http://www.agpad.com/downloads/com.spket.js_1.6.22.jar and try again.

EasonLin
Posts: 5
Joined: Tue Mar 06, 2012 3:55 am

Re: JSDoc description not displayed

Post by EasonLin » Thu Mar 08, 2012 1:37 am

I have used this fix and tried to display the description, but still not working.
Then I tried to change the library from Common to Prototype and the description is displayed !!
Maybe there is still something wrong somewhere.

I don't know the difference between the librarys. I thought that just some pre-create library for easy using. :(

Thanks for your help !!

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

Re: JSDoc description not displayed

Post by eric_suen » Thu Mar 08, 2012 3:51 pm

if Prototype works, then the common library should works too, now they use same way to handle to document, are you sure you install the fix correctly?

if you install spket in default location, the location should be eclipse/plugins

EasonLin
Posts: 5
Joined: Tue Mar 06, 2012 3:55 am

Re: JSDoc description not displayed

Post by EasonLin » Fri Mar 09, 2012 1:34 am

This morning I donwload the Spket IDE jar and install the eclipse plugin in my eclipse folder.
And I download and replace the fix from plugins folder again.
Then the jsDoc description is displayed perfectly !!

Sorry, I think I must do something dumb !!
I really appreciate you, your timely help, your patient with a dumb !! :shock:
Thank you !!

Post Reply

Who is online

Users browsing this forum: No registered users and 1 guest