summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhilippe Marschall2012-04-16 11:27:54 (EDT)
committer Markus Keller2012-04-16 11:27:54 (EDT)
commite348b9f4db49794fd46b860d8124abeb408eeb61 (patch)
tree97d19c8ab26436120a391210efe0c223790d6755
parent1645fa21e2b2453126277a6d41baeeb71cc3b5ca (diff)
downloadeclipse.platform.common-e348b9f4db49794fd46b860d8124abeb408eeb61.zip
eclipse.platform.common-e348b9f4db49794fd46b860d8124abeb408eeb61.tar.gz
eclipse.platform.common-e348b9f4db49794fd46b860d8124abeb408eeb61.tar.bz2
Bug 86168: [type wizards] Allow the creation of a compilation unitv20120416-1527I20120419-1434I20120418-0248
called package-info.java
-rw-r--r--bundles/org.eclipse.jdt.doc.user/reference/ref-wizard-package.htm30
1 files changed, 28 insertions, 2 deletions
diff --git a/bundles/org.eclipse.jdt.doc.user/reference/ref-wizard-package.htm b/bundles/org.eclipse.jdt.doc.user/reference/ref-wizard-package.htm
index 8cbe974..31b37de 100644
--- a/bundles/org.eclipse.jdt.doc.user/reference/ref-wizard-package.htm
+++ b/bundles/org.eclipse.jdt.doc.user/reference/ref-wizard-package.htm
@@ -2,7 +2,7 @@
<html lang="en">
<head>
-<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2008. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
+<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2012. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." >
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta http-equiv="Content-Style-Type" content="text/css">
@@ -18,7 +18,9 @@
<a class="command-link" href='javascript:executeCommand("org.eclipse.ui.newWizard(newWizardId=org.eclipse.jdt.ui.wizards.NewPackageCreationWizard)")'>
<img src="PLUGINS_ROOT/org.eclipse.help/command_link.png" alt="Opens the New Java Package wizard">
<b>New Java Package</b></a> wizard
- helps you create a folder corresponding to a new Java package. The corresponding folder of the default package always exists, and therefore doesn't have to be
+ helps you create a folder corresponding to a new Java package and optionally a package level documentation file. It can also be used to add package level documentation to an existing package.</p>
+
+ <p>The corresponding folder of the default package always exists, and therefore doesn't have to be
created.</p>
<table border="1" cellspacing="0" cellpadding="5" summary="Java Package Options">
@@ -49,6 +51,30 @@
<td align="left" valign="top">&lt;blank&gt;</td>
</tr>
+
+ <tr>
+ <td align="left" valign="top">Create package-info.java</td>
+
+ <td align="left" valign="top">
+ <p>Whether a <code>package-info.java</code> file should be created in the package.</p>
+
+ <p>The <code>package-info.java</code> file contains package level documentation as well as annotations. For example:</p>
+
+<pre><code>
+/**
+ * This package contains JAXB classes.
+ */
+@XmlSchema(namespace = "http://www.example.com", elementFormDefault = XmlNsForm.QUALIFIED)
+package com.acme.jaxb;
+</code></pre>
+
+ <p>For more information, refer to the <a href="http://docs.oracle.com/javase/specs/jls/se7/html/jls-7.html#jls-7.4.1">Java Language Specification Section 7.4.1. Named Packages</a>.</p>
+
+ <p>If the source level is 1.4 or below, a <code>package.html</code> will be created instead.</p>
+ </td>
+
+ <td align="left" valign="top">false</td>
+ </tr>
</table>
<p>