Eclipse Community Forums
Forum Search:

Search      Help    Register    Login    Home
Home » Eclipse Projects » Web Tools Project (WTP) » Several Questions About JSDoc
Several Questions About JSDoc [message #233401] Wed, 08 July 2009 01:05 Go to next message
YaoXing Zhang is currently offline YaoXing Zhang
Messages: 7
Registered: July 2009
Junior Member
Hi All,
As I'm trying to develop JavaScript with WTP 3.1, here I met several
questions about JSDoc.
1. Are we using the same JSDoc grammar as JSDoc-toolkit? Because I read
the instruction from http://jsdoc.sourceforge.net/#usage and the JSDoc
in ECMAScript Build-In Library, they seems to be different.
2. How can I generate HTML doc from JavaScript source file? I select
Project->Generate JSDoc..., and it asks me for the JSDoc command line. I
tried JSDoc-toolkit and it doesn't work. Then I can't even close the
dialog box until I unselected all the JavaScript files in this box.

Any help would be appreciated.

Regards,
Yaoxing
Re: Several Questions About JSDoc [message #233416 is a reply to message #233401] Wed, 08 July 2009 15:56 Go to previous messageGo to next message
Chris Jaun is currently offline Chris Jaun
Messages: 17
Registered: July 2009
Junior Member
Yaoxing Zhang wrote:

> 1. Are we using the same JSDoc grammar as JSDoc-toolkit? Because I read
> the instruction from http://jsdoc.sourceforge.net/#usage and the JSDoc
> in ECMAScript Build-In Library, they seems to be different.

The usage of JSdoc in JSDT should be the same or similar to JSDoc-toolkit.
What difference did you find? Please open bugzillas if you have specific
problems with it.


> 2. How can I generate HTML doc from JavaScript source file? I select
> Project->Generate JSDoc..., and it asks me for the JSDoc command line. I
> tried JSDoc-toolkit and it doesn't work. Then I can't even close the
> dialog box until I unselected all the JavaScript files in this box.

Generating HTML using the JSDT tooling is not currently supported.
Actually I thought that menu option had been removed. Which version of WTP
are you using?

Thanks,
Chris
Re: Several Questions About JSDoc [message #233421 is a reply to message #233416] Wed, 08 July 2009 19:36 Go to previous messageGo to next message
YaoXing Zhang is currently offline YaoXing Zhang
Messages: 7
Registered: July 2009
Junior Member
Chris Jaun wrote:
> The usage of JSdoc in JSDT should be the same or similar to
> JSDoc-toolkit. What difference did you find? Please open bugzillas if
> you have specific problems with it.
>
Only a little bit difference actually, the @member is used as @memberOf.
What confusing me is that the code assist seems not be able to suggest
all the keywords of JSDoc, and in the JSDoc view it seems some keywords
like @private, @type, @since etc., they are not correctly recognized.
This makes me want to confirm if we are using the old JSDoc grammar.
>
> Generating HTML using the JSDT tooling is not currently supported.
> Actually I thought that menu option had been removed. Which version of
> WTP are you using?
I down loaded the latest version of Eclipse and WTP last week.
Eclipse: 3.5.0
WTP: the version of package name says wtp-R-3.1-20090616035105, while in
Eclipse about menu, it's 3.1.0.v200906080522
I also installed EMF, GEF and XSD. Do I miss something?
By the way, is there any plans of exporting JSDoc?
>
> Thanks,
> Chris
>
Re: Several Questions About JSDoc [message #233464 is a reply to message #233421] Thu, 09 July 2009 17:06 Go to previous messageGo to next message
Chris Jaun is currently offline Chris Jaun
Messages: 17
Registered: July 2009
Junior Member
Yaoxing Zhang wrote:

> Chris Jaun wrote:
>> The usage of JSdoc in JSDT should be the same or similar to
>> JSDoc-toolkit. What difference did you find? Please open bugzillas if
>> you have specific problems with it.
>>
> Only a little bit difference actually, the @member is used as @memberOf.
> What confusing me is that the code assist seems not be able to suggest
> all the keywords of JSDoc, and in the JSDoc view it seems some keywords
> like @private, @type, @since etc., they are not correctly recognized.
> This makes me want to confirm if we are using the old JSDoc grammar.


At this point in JSDT's development we've focused on getting the JSdoc
params that we use to help infer types working correctly. Its very
possible that some others are missing and not working quite right.
Eventually we do want to get those all working.

>>
>> Generating HTML using the JSDT tooling is not currently supported.
>> Actually I thought that menu option had been removed. Which version of
>> WTP are you using?
> I down loaded the latest version of Eclipse and WTP last week.
> Eclipse: 3.5.0
> WTP: the version of package name says wtp-R-3.1-20090616035105, while in
> Eclipse about menu, it's 3.1.0.v200906080522
> I also installed EMF, GEF and XSD. Do I miss something?
> By the way, is there any plans of exporting JSDoc?

Right now supporting the exporting of JSDoc is very low on the priority
list. Almost no chance it will be in WTP 3.2 unless someone contributes it.
Re: Several Questions About JSDoc [message #233480 is a reply to message #233464] Thu, 09 July 2009 17:31 Go to previous message
YaoXing Zhang is currently offline YaoXing Zhang
Messages: 7
Registered: July 2009
Junior Member
I see. I think I can still use JSDoc-toolkit to export the documents.
Thank you for help.

Chris Jaun wrote:
> Yaoxing Zhang wrote:
>
>> Chris Jaun wrote:
>>> The usage of JSdoc in JSDT should be the same or similar to
>>> JSDoc-toolkit. What difference did you find? Please open bugzillas if
>>> you have specific problems with it.
>>>
>> Only a little bit difference actually, the @member is used as
>> @memberOf. What confusing me is that the code assist seems not be
>> able to suggest all the keywords of JSDoc, and in the JSDoc view it
>> seems some keywords like @private, @type, @since etc., they are not
>> correctly recognized. This makes me want to confirm if we are using
>> the old JSDoc grammar.
>
>
> At this point in JSDT's development we've focused on getting the JSdoc
> params that we use to help infer types working correctly. Its very
> possible that some others are missing and not working quite right.
> Eventually we do want to get those all working.
>
>>>
>>> Generating HTML using the JSDT tooling is not currently supported.
>>> Actually I thought that menu option had been removed. Which version
>>> of WTP are you using?
>> I down loaded the latest version of Eclipse and WTP last week.
>> Eclipse: 3.5.0
>> WTP: the version of package name says wtp-R-3.1-20090616035105, while
>> in Eclipse about menu, it's 3.1.0.v200906080522
>> I also installed EMF, GEF and XSD. Do I miss something?
>> By the way, is there any plans of exporting JSDoc?
>
> Right now supporting the exporting of JSDoc is very low on the priority
> list. Almost no chance it will be in WTP 3.2 unless someone contributes it.
>
>
Previous Topic:How to embedded wtp javascript editor to other editor?
Next Topic:question on wtp galileo editor ...
Goto Forum:
  


Current Time: Wed Sep 17 09:38:38 GMT 2014

Powered by FUDForum. Page generated in 0.02524 seconds
.:: Contact :: Home ::.

Powered by: FUDforum 3.0.2.
Copyright ©2001-2010 FUDforum Bulletin Board Software