Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 341388 - Run jsdoc on more source code in the build
Summary: Run jsdoc on more source code in the build
Status: RESOLVED FIXED
Alias: None
Product: Orion
Classification: ECD
Component: Client (show other bugs)
Version: 0.2   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 0.2   Edit
Assignee: Project Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-03-30 11:51 EDT by Mark Macdonald CLA
Modified: 2011-09-01 11:42 EDT (History)
1 user (show)

See Also:

Attachments
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 Mark Macdonald CLA 2011-03-30 11:51:15 EDT 
Currently the build runs jsdoc on files in these directories:
 org.eclipse.orion.client.core/static/js/
 org.eclipse.orion.client.editor/web/js/

Some of our code is now in subdirectories of these, so we should consider passing the -r=<DEPTH> argument to jsdoc, which makes it recurse into subdirectories.

We've also now got client code defined in other bundles, like:
 org.eclipse.orion.client.git
 org.eclipse.orion.client.users.ui

If this is intended to be API (and I think it is -- at least the Git stuff), then we should add those to the list of directories.
Comment 1 Andrew Niefer CLA 2011-03-31 10:59:54 EDT 
Done, I added -r=3 and both client.git and client.users.ui