diff options
| author | Mickael Istria | 2018-11-28 17:39:47 +0000 |
|---|---|---|
| committer | Sarika Sinha | 2018-12-01 19:12:43 +0000 |
| commit | 4aae264ce498b4568d107dce8fe61dd49fed2ebc (patch) | |
| tree | 071e61066cfc260cf30d8f3960a2fb5e6c5b2071 | |
| parent | 0b2895a2b489a15e433b74ea9c7cc05724f80356 (diff) | |
| download | eclipse.platform.common-4aae264ce498b4568d107dce8fe61dd49fed2ebc.tar.gz eclipse.platform.common-4aae264ce498b4568d107dce8fe61dd49fed2ebc.tar.xz eclipse.platform.common-4aae264ce498b4568d107dce8fe61dd49fed2ebc.zip | |
Bug 541407 - Documentation about JDT code minings preference pageI20181202-1800I20181202-0600I20181201-1800
Change-Id: I4ddeb6dd9d6880072f519c5c0f5c0709dd19fb1d
Signed-off-by: Mickael Istria <mistria@redhat.com>
3 files changed, 108 insertions, 0 deletions
diff --git a/bundles/org.eclipse.jdt.doc.user/contexts_JDT.xml b/bundles/org.eclipse.jdt.doc.user/contexts_JDT.xml index 332aee4c7..15beffb0f 100644 --- a/bundles/org.eclipse.jdt.doc.user/contexts_JDT.xml +++ b/bundles/org.eclipse.jdt.doc.user/contexts_JDT.xml @@ -928,6 +928,12 @@ <topic label="Configuring accessibility options for textual editors" href="PLUGINS_ROOT/org.eclipse.platform.doc.user/concepts/accessibility/text_editor.htm"/> </context> + <context id="code_mining_preference_page_context"> + <description>On this page, you can indicate your preferences for showing code mining decorations in the Java editor.</description> + <topic label="Code mining preferences" href="reference/preferences/java/editor/ref-preferences-code-minings.htm"/> + <topic label="Java editor preferences" href="reference/preferences/java/ref-preferences-editor.htm"/> + </context> + <context id="typing_preference_page_context"> <description>On this page you can indicate your smart typing preferences for the Java editor. diff --git a/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/editor/ref-preferences-code-minings.htm b/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/editor/ref-preferences-code-minings.htm new file mode 100644 index 000000000..9d4a3620a --- /dev/null +++ b/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/editor/ref-preferences-code-minings.htm @@ -0,0 +1,101 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> +<head> +<meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2016. 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"> +<title>Java Code Minings Preferences</title> +<link rel="stylesheet" href="../../../../book.css" charset="ISO-8859-1" type="text/css"> +<script language="JavaScript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js" type="text/javascript"> </script> +</head> +<body> +<h1>Java Code Minings Preferences</h1> +<p>Indicate your preferences for the Code Minings settings on the <a class="command-link" href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=org.eclipse.jdt.ui.preferences.JavaEditorCodeMiningPreferencePage)")'> <img src="PLUGINS_ROOT/org.eclipse.help/command_link.png" alt="Opens the Code Minings preference page"> +<b> Java > Editor > Code Minings</b></a> preference page.</p> +<table border="1" cellspacing="0" cellpadding="5" width="100%" summary="Content Assist settings"> + <thead> + <tr> + <th> + <p>Option</p> + </th> + <th> + <p>Description</p> + </th> + <th> + <p>Default</p> + </th> + </tr> + </thead> + <tbody> + <tr> + <td valign="top">Enable Code Minings</td> + <td valign="top"> + If enabled, selected Code Minings will be shown as decoration on the Java editor. + </td> + <td valign="top"> + Off + </td> + </tr> + <tr> + <td valign="top" style="padding-left: 1em;">Only if there is at least on result</td> + <td valign="top"> + If enabled, Code Minings counting elements will not be shown if 0 elements are found. + </td> + <td valign="top"> + On + </td> + </tr> + <tr> + <td valign="top" colspan="3"><h2>General</h2></td> + </tr> + <tr> + <td valign="top">Show references for</td> + <td valign="top"> + If enabled, the count of workspace references will be shown for the Java elements selected below. + </td> + <td valign="top"> + On + </td> + </tr> + <tr> + <td valign="top" style="padding-left: 1em;">Types</td> + <td valign="top"> + If enabled, the count of workspace references will be shown for the Java types in the Java editor. + </td> + <td valign="top"> + On + </td> + </tr> + <tr> + <td valign="top" style="padding-left: 1em;">Fields</td> + <td valign="top"> + If enabled, the count of workspace references will be shown for the Java fields in the Java editor. + </td> + <td valign="top"> + On + </td> + </tr> + <tr> + <td valign="top" style="padding-left: 1em;">Methods</td> + <td valign="top"> + If enabled, the count of workspace references will be shown for the Java methods in the Java editor. + </td> + <td valign="top"> + On + </td> + </tr> + <tr> + <td valign="top">Show implementations</td> + <td valign="top"> + If enabled, the count of implementations will be shown for the Java types in the Java editor. + </td> + <td valign="top"> + On + </td> + </tr> + </tbody> +</table> +<p><img src="../../../../images/ngrelr.png" alt="Related reference" border="0"></p> +<p><a href="../../../../reference/ref-dialog-java-search.htm">Java Search dialog</a><br> +<a href="../appearance/ref-menu-search.htm">Search menu</a></p> +</body> +</html> diff --git a/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/ref-preferences-editor.htm b/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/ref-preferences-editor.htm index aa3fa44ba..57165241c 100644 --- a/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/ref-preferences-editor.htm +++ b/bundles/org.eclipse.jdt.doc.user/reference/preferences/java/ref-preferences-editor.htm @@ -21,6 +21,7 @@ and its sub-pages. </p> <ul> + <li><a href="editor/ref-preferences-code-minings.htm">Code Minings</a> <li><a href="editor/ref-preferences-content-assist.htm">Content Assist</a> <ul> <li><a href="editor/ref-preferences-content-assist-advanced.htm">Advanced</a></li> |
