This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 43383 - Need API docs for syntax & semantics of new project & file creation
Summary: Need API docs for syntax & semantics of new project & file creation
Status: CLOSED FIXED
Alias: None
Product: usersguide
Classification: Unclassified
Component: Projects (show other bugs)
Version: 4.x
Hardware: All All
: P3 blocker (vote)
Assignee: Petr Hrebejk
URL:
Keywords: API
Depends on:
Blocks: 40703
  Show dependency tree
 
Reported: 2004-05-17 15:48 UTC by Jesse Glick
Modified: 2012-03-03 11:32 UTC (History)
1 user (show)

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jesse Glick 2004-05-17 15:48:57 UTC
We need to have complete & precise API
documentation for both the syntax and semantics of
layer-based registration of

- new project wizards

- new file templates, both with and without custom
wizard iterators

Need to document at least

- location in layer

- recognized file attributes affecting behavior 
(e.g. template, templateWizardIterator or
instantiatingWizardIterator or whatever it is,
instantiatingWizardURL), each with the permitted
interface types of the attribute; also mention
standard attributes (SystemFileSystem.*) affecting
display

- behavior of template categories (attributes and
so on)

- expected element type(s) of the Set returned
from InstantiatingWizard

- default semantics of file templates with no
custom iterator

- semantics of any API-visible privileged list

Also any interesting behavior which is not
guaranteed by the API (e.g. location of any
persisted list of recently used templates) should
be mentioned in the appropriate arch.xml.

Don't worry about making the docs extremely
user-friendly or pretty etc. - first we need
everything written down.

Remember that you can use package.html for docs
specific to a package but not any single class,
and overview.html for docs specific to a module
but not any single class or package.
Comment 1 Jesse Glick 2004-06-15 13:19:34 UTC
Needed fairly soon, for DevRev.
Comment 2 Petr Hrebejk 2004-06-15 13:51:00 UTC
I think Jirka wrote something into the twiki (not open) maybe he
should put the text into ProjectUIAPI javadoc as some package.html
Comment 3 Jiri Rechtacek 2004-06-16 15:38:11 UTC
Log: added description of templates support in Project UI API
(but some parts of description are still missing, this issue leaves
opened)

RCS file: /cvs/projects/projectuiapi/overview.html,v
done
Checking in overview.html;
/cvs/projects/projectuiapi/overview.html,v  <--  overview.html
initial revision: 1.1
done
Processing log script arguments...
More commits to come...
Checking in nbproject/project.properties;
/cvs/projects/projectuiapi/nbproject/project.properties,v  <-- 
project.properties
new revision: 1.4; previous revision: 1.3
done
Processing log script arguments...
More commits to come...
RCS file:
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/templates/support/package.html,v
done
Checking in
src/org/netbeans/spi/project/ui/templates/support/package.html;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/templates/support/package.html,v
 <--  package.html
initial revision: 1.1
done
Comment 4 Petr Hrebejk 2004-06-23 14:13:28 UTC
All required info hopefully added into the description of
org.netbeans.spi.project.ui.templates.support package. The file is
linked from Recommended/PriviledgedTemplates classes.
(LRU of templates is currently stored in a SystemOption and does not
have any API)

Checking in src/org/netbeans/spi/project/ui/PrivilegedTemplates.java;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/PrivilegedTemplates.java,v
 <--  PrivilegedTemplates.java
new revision: 1.3; previous revision: 1.2
done
Checking in src/org/netbeans/spi/project/ui/RecommendedTemplates.java;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/RecommendedTemplates.java,v
 <--  RecommendedTemplates.java
new revision: 1.3; previous revision: 1.2
done
Processing log script arguments...
More commits to come...
Checking in
src/org/netbeans/spi/project/ui/templates/support/package.html;
/cvs/projects/projectuiapi/src/org/netbeans/spi/project/ui/templates/support/package.html,v
 <--  package.html
new revision: 1.2; previous revision: 1.1
done
Comment 5 Marian Mirilovic 2005-12-20 15:48:26 UTC
This issue was solved long time ago. Because nobody has reopened it neither
added comments, we are verifying/closing it now. 
If you are still able to reproduce the problem, please reopen. Thanks in advance.
Comment 6 Quality Engineering 2012-03-03 11:32:22 UTC
Integrated into 'main-golden', will be available in build *201203030400* on http://bits.netbeans.org/dev/nightly/ (upload may still be in progress)
Changeset: http://hg.netbeans.org/main-golden/rev/531c41f225c4
User: Jesse Glick <jglick@netbeans.org>
Log: Removing old list of templates, project types, and template categories.
This documentation need (#43383) could be better satisfied by a generated summary.