Bug 300677 - [misc] Open Attached JSDoc is not compatible with JSDoc-toolkit
Summary: [misc] Open Attached JSDoc is not compatible with JSDoc-toolkit
Status: NEW
Alias: None
Product: JSDT
Classification: WebTools
Component: General (show other bugs)
Version: 3.1   Edit
Hardware: PC Windows XP
: P3 normal (vote)
Target Milestone: Future   Edit
Assignee: Project Inbox CLA
QA Contact: Chris Jaun CLA
URL:
Whiteboard:
Keywords: plan
Depends on:
Blocks:
 
Reported: 2010-01-25 09:26 EST by Wojciech Galanciak CLA
Modified: 2014-05-29 13:51 EDT (History)
5 users (show)

See Also:
thatnitind: review? (cmjaun)

Attachments
test project (1.54 KB, application/x-zip)
2010-01-25 09:26 EST, Wojciech Galanciak CLA 		no flags Details
test JSDoc generated by JSDoc-toolkit (8.69 KB, application/x-zip)
2010-01-25 09:27 EST, Wojciech Galanciak CLA 		no flags Details
proposed patch (4.87 KB, patch)
2010-09-14 04:35 EDT, Jakub Jurkiewicz CLA 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Wojciech Galanciak CLA 2010-01-25 09:26:35 EST 
Created attachment 157119 [details]
test project

JSDoc-toolkit creates different folders structure that JSDoc (http://jsdoc.sourceforge.net/). It has folder symbols where are stored html files with generated JSDocs. Unfortunately, when we try to open attached JSDoc wrong patch is built. For example, in attached test project and test JSDoc:
1. Import attached test project.
2. Extract testJSDoc.
4. Set JSDoc location for folder with extracted JSDoc.
5. Set focus on Shape() in source editor.
6. Choose Nagivate->Open Attached JSDoc - it try to open ../aaa//Shape.html which doesn't exist. It should be ../aaa/symbols/Shape.html.
Comment 1 Wojciech Galanciak CLA 2010-01-25 09:27:12 EST 
Created attachment 157120 [details]
test JSDoc generated by JSDoc-toolkit
Comment 2 Jakub Jurkiewicz CLA 2010-09-14 04:35:30 EDT 
Created attachment 178794 [details]
proposed patch

There is a different folder structure generated by JSDoc and JSDoc-toolkit. First we try JSDocs location, if it exists we display the documentation, if it does not exist we try to load the documentation generated with JSDoc-toolkit.
Comment 3 Nitin Dahyabhai CLA 2010-10-08 14:34:36 EDT 
Is there any way to accomplish this without opening a possibly sluggish connection to a remote server?  I can see the usefulness of supporting both versions on the local filesystem, but remotely I'd rather keep the network involvement down and just support the current JSDoc 2.x (JSDoc-toolkit) path.
Comment 4 Krzysztof Daniel CLA 2010-10-14 06:59:38 EDT 
The user can set a URL which points to the remote location, so why we should not support that?
Comment 5 Jacek Pospychala CLA 2010-10-14 08:23:50 EDT 
if user is setting the URL, couldn't he append "/symbols" by himself?