Skip to content

Commit

Permalink
Write HTML-Headers in Title Case in jdt.doc.isv
Browse files Browse the repository at this point in the history
  • Loading branch information
@BeckerWdf
BeckerWdf committed Oct 4, 2024
1 parent 7667eae commit e2b5bae
Show file tree
Hide file tree
Showing 84 changed files with 175 additions and 174 deletions.
2 changes: 1 addition & 1 deletion eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<link rel="stylesheet" type="text/css" href="../book.css">
</head>
<body>
<h1>JDT structure and API</h1>
<h1>JDT Structure and API</h1>
<p>Given that the JDT supplies a full featured Java IDE, why would you need to
use the JDT API?</p>
<p>If you are building a plug-in that interacts with Java programs or resources
Expand Down
12 changes: 6 additions & 6 deletions eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_classpath.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<link rel="stylesheet" type="text/css" href="../book.css" />
</head>
<body>
<h2>Setting the Java build path</h2>
<h2>Setting the Java Build Path</h2>
<p>This section describes how to set the Java build path.&nbsp; The build path is the classpath
that is used for building a Java project (<b><a href=
"../reference/api/org/eclipse/jdt/core/IJavaProject.html">IJavaProject</a></b>).</p>
Expand All @@ -29,7 +29,7 @@ <h2>Setting the Java build path</h2>
separately from the build path.&nbsp; (See <b><a href="../guide/jdt_api_run.htm">Running Java
code</a></b> for a discussion of the runtime classpath.)</p>

<h3>Changing the build path</h3>
<h3>Changing the Build Path</h3>
<p>You can programmatically change a project's build path using <b><a href=
"../reference/api/org/eclipse/jdt/core/IJavaProject.html#setRawClasspath(org.eclipse.jdt.core.IClasspathEntry[],%20org.eclipse.core.runtime.IProgressMonitor)">
setRawClasspath</a></b> on the corresponding project's Java element.&nbsp; The following code sets
Expand All @@ -49,7 +49,7 @@ <h3>Changing the build path</h3>
structure.&nbsp; The purpose of this file is to provide a way to share Java build path settings
with others through some source code repository. In particular, this file should not be manually
edited, since it may get corrupted.</p>
<h3>Classpath entries</h3>
<h3>Classpath Entries</h3>
<p>Classpath entries can be defined using factory methods defined on <b><a href=
"../reference/api/org/eclipse/jdt/core/JavaCore.html">JavaCore</a></b>.&nbsp; Classpath entries can
reference any of the following:</p>
Expand Down Expand Up @@ -205,7 +205,7 @@ <h3>Classpath entries</h3>
null);
</pre></li>
</ul>
<h3>Exclusion patterns</h3>
<h3>Exclusion Patterns</h3>
<p>A classpath source entry may be assigned an exclusion pattern, which prevents certain resources
in a source folder from being visible on the classpath.&nbsp; Using a pattern allows specified
portions of the resource tree to be filtered out.&nbsp; Each exclusion pattern path is relative to
Expand Down Expand Up @@ -238,7 +238,7 @@ <h3>Exclusion patterns</h3>

</pre></li>
</ul>
<h3>Inclusion patterns</h3>
<h3>Inclusion Patterns</h3>
<p>A classpath source entry may also be assigned an inclusion pattern, which explicitly defines
resources to be visible on the classpath.&nbsp; When no inclusion patterns are specified, the
source entry includes all relevant files in the resource tree rooted at this source entry's path.
Expand Down Expand Up @@ -267,7 +267,7 @@ <h3>Inclusion patterns</h3>
<code>src/**/Foo.java</code> includes all files under a root folder named <code>src</code> except
for ones named <code>Foo.java</code>.</li>
</ul>
<h2>Classpath resolution</h2>
<h2>Classpath Resolution</h2>
Since classpath variables and containers allow you to define dynamically bound classpath entries,
the classpath API distinguishes between a raw and a resolved classpath.&nbsp;&nbsp; The raw
classpath is the one originally set on the Java project using <b><a href=
Expand Down
18 changes: 9 additions & 9 deletions eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_codeassist.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<link rel="stylesheet" type="text/css" href="../book.css" />
</head>
<body>
<h2>Performing code assist on Java code</h2>
<h2>Performing Code Assist on Java Code</h2>
<p>The JDT API allows other plug-ins to perform code assist or code select on some Java elements.
Elements that allow this manipulation should implement <b><a href=
"../reference/api/org/eclipse/jdt/core/ICodeAssist.html">ICodeAssist</a></b>.</p>
Expand All @@ -27,8 +27,8 @@ <h2>Performing code assist on Java code</h2>
"../reference/api/org/eclipse/jdt/core/ICompilationUnit.html">ICompilationUnit</a></b>.&nbsp; Code
completion and code selection only answer results for a class file if it has attached source.</p>

<h3>Code completion</h3>
<h4>Performing a code completion</h4>
<h3>Code Completion</h3>
<h4>Performing a Code Completion</h4>
<p>One way to programmatically perform code completion is to invoke <b><a href=
"../reference/api/org/eclipse/jdt/core/ICodeAssist.html#codeComplete(int,%20org.eclipse.jdt.core.CompletionRequestor)">
ICodeAssist.codeComplete</a></b>. You specify the offset in the compilation unit after which the
Expand Down Expand Up @@ -76,7 +76,7 @@ <h4>Performing a code completion</h4>
"../reference/api/org/eclipse/jdt/core/CompletionProposal.html#VARIABLE_DECLARATION">VARIABLE_DECLARATION</a></b></li>
</ul>
<p>The completion requestor must also be able to accept compilation errors.&nbsp;&nbsp;</p>
<h4>Completion relevance</h4>
<h4>Completion Relevance</h4>
<p>Because there may be many different possible completions, the notion of relevance is used to
compare the relevance of a suggested completion to other proposals.&nbsp; Relevance is represented
by a positive integer.&nbsp; The value has no implicit meaning except to be used relative to the
Expand All @@ -85,7 +85,7 @@ <h4>Completion relevance</h4>
variable types, cast types, return types, etc.&nbsp; The presence of an expected prefix or suffix
in a completion also affects its relevance.</p>

<h4>Completion context</h4>
<h4>Completion Context</h4>
<p>An instance of <b><a href=
"../reference/api/org/eclipse/jdt/core/CompletionRequestor.html">CompletionRequestor</a></b> can
also accept a completion context. This context is given by the method <b><a href=
Expand All @@ -112,7 +112,7 @@ <h4>Completion context</h4>
getVisibleElements(String)</a></b> - This method returns the elements which are visible from the
completion location and which can be assigned to the given type</li>
</ul>
<h4>Code completion options</h4>
<h4>Code Completion Options</h4>
<p>The JDT Core plug-in defines options that control the behavior of code completion.&nbsp; These
options can be changed by other plug-ins.&nbsp;&nbsp;</p>

Expand All @@ -129,8 +129,8 @@ <h4>Code completion options</h4>
<p>See&nbsp; <a href="jdt_api_options.htm#codeassist">JDT Core Code Assist Options</a> for more
information about the code assist options and their defaults.</p>

<h3>Code selection</h3>
<h4>Performing a code selection</h4>
<h3>Code Selection</h3>
<h4>Performing a Code Selection</h4>
<p>Code selection is used to find the Java element represented by a range of text (typically the
selected text) in a compilation unit.&nbsp; To programmatically perform code selection, you must
invoke <b><a href=
Expand All @@ -151,7 +151,7 @@ <h4>Performing a code selection</h4>
IJavaElement[] elements = unit.codeSelect(offset, length);
System.out.println("the selected element is " + element[0].getElementName());
</pre>
<h4>Selection at cursor location</h4>
<h4>Selection at Cursor Location</h4>

<p>When the selection length is specified as 0, a selection will be computed by finding the
complete token that encloses the specified offset.&nbsp; Consider the following example method:</p>
Expand Down
18 changes: 9 additions & 9 deletions eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_codeformatter.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
</head>
<body>
<h2>
Using the code formatter
Using the Code Formatter
</h2>
<p>
The JDT API allows other plug-ins to use the default
Expand Down Expand Up @@ -47,7 +47,7 @@ <h2>
by clients.
</p>
<h3>
Getting a code formatter instance
Getting a Code Formatter Instance
</h3>

<p>
Expand Down Expand Up @@ -152,7 +152,7 @@ <h3>
options relative to code wrapping.
</p>
<h3>
Invoking the code formatter
Invoking the Code Formatter
</h3>

<p>
Expand Down Expand Up @@ -243,7 +243,7 @@ <h4>
}
</pre>
<h3>
Formatting a set of regions
Formatting a Set of Regions
</h3>
<p>

Expand Down Expand Up @@ -321,7 +321,7 @@ <h3>
</ul>

<h3>
Comment formatter options
Comment Formatter Options
</h3>
<p>
Various formatting options are available in order to format
Expand Down Expand Up @@ -349,7 +349,7 @@ <h3>
</p>
<h3>

Formatting comments with the stand-alone formatter
Formatting Comments With the Stand-alone Formatter
</h3>
<p>
The default <b><a href=
Expand All @@ -372,7 +372,7 @@ <h3>
<li>

<h4>
Formatting javadoc comments
Formatting Javadoc Comments
</h4>
<p>
The following unformatted javadoc:
Expand Down Expand Up @@ -416,7 +416,7 @@ <h4>
</li>
<li>
<h4>
Formatting multi-line comments
Formatting Multi-line Comments
</h4>
<p>
The following unformatted multi-line comment:
Expand Down Expand Up @@ -460,7 +460,7 @@ <h4>
</li>
<li>
<h4>
Formatting single line comments
Formatting Single Line Comments
</h4>
<p>
The following unformatted single line comments:
Expand Down
6 changes: 3 additions & 3 deletions eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_compile.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<link rel="stylesheet" type="text/css" href="../book.css" />
</head>
<body>
<h2>Compiling Java code</h2>
<h2>Compiling Java Code</h2>
<p> See the
Java development user guide for <a href="PLUGINS_ROOT/org.eclipse.jdt.doc.user/tasks/task-using_batch_compiler.htm">using the batch compiler</a> and
<a href="PLUGINS_ROOT/org.eclipse.jdt.doc.user/tasks/task-ant_javac_adapter.htm">using the ant javac adapter</a>.</p>
Expand All @@ -20,7 +20,7 @@ <h2>Compiling Java code</h2>
Java projects. Compilation is triggered using standard platform build mechanisms.</p>

<p>The platform build mechanism is described in detail in <a href="../../org.eclipse.platform.doc.isv/guide/resAdv_builders.htm" class="XRef">Incremental project builders</a>.</p>
<h3>Compiling code</h3>
<h3>Compiling Code</h3>
<p>You can programmatically compile the Java source files in a project using the build API.</p>
<pre class="color1">

Expand Down Expand Up @@ -60,7 +60,7 @@ <h3>Compiling code</h3>
myProject.setOptions(options);
</span>
</pre>
<h3>Problem determination</h3>
<h3>Problem Determination</h3>

<p>JDT Core defines a specialized marker (marker type "<b>org.eclipse.jdt.core.problem</b> ") to denote compilation problems. To programmatically discover problems detected by the compiler, the
standard platform marker protocol should be used. See <a href="../../org.eclipse.platform.doc.isv/guide/resAdv_markers.htm" class="XRef">Resource Markers</a> for an overview of using markers.</p>
Expand Down
10 changes: 5 additions & 5 deletions ....platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_contributing_a_cleanup.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@

</head>
<body>
<h2>Contributing a clean up and a save action using the <b>clean up</b> extension point</h2>
<h2>Contributing a Clean Up and a Save Action Using the <b>Clean Up</b> Extension Point</h2>

<p>The <a href=
"../reference/extension-points/org_eclipse_jdt_ui_cleanUps.html"><b>org.eclipse.jdt.ui.cleanUps</b></a>
extension point enables you to contribute your own Java code clean ups and Java editor save
actions. Clean ups help in resolving problems in a compilation unit or establishing a code style. A
save action is a special clean up that perform the requested modifications on save
automatically.</p>
<h3>Using the extension point</h3>
<h3>Using the Extension Point</h3>
<p>To create a new extension for the <a href=
"../reference/extension-points/org_eclipse_jdt_ui_cleanUps.html"><b>org.eclipse.jdt.ui.cleanUps</b></a>
extension point you need to first provide the required extensions in the plugin.xml. There are 3
Expand Down Expand Up @@ -49,7 +49,7 @@ <h3>Using the extension point</h3>

<p>For a description of the individual attributes, please refer to the extension point
documentation.</p>
<h3>Contributing a clean up</h3>
<h3>Contributing a Clean Up</h3>
<p>To contribute a clean up, you need to first create the class that implements the <a href=
"../reference/api/org/eclipse/jdt/ui/cleanup/ICleanUp.html"><b>ICleanUp</b></a> Interface. Lets
create the <code>CopyrightUpdaterCleanUp</code> class for our example clean up and implement the
Expand Down Expand Up @@ -132,7 +132,7 @@ <h3>Contributing a clean up</h3>
return CopyrightsFix.createCleanUp(compilationUnit, fOptions.isEnabled("cleanup.update_copyrights"));//$NON-NLS-1$
}
</pre>
<h3>Contributing a clean up options provider</h3>
<h3>Contributing a Clean Up Options Provider</h3>
<p>To create the UI for the clean up, an options provider tab page has to be created by
implementing the <a href=
"../reference/api/org/eclipse/jdt/ui/cleanup/ICleanUpConfigurationUI.html"><b>ICleanUpConfigurationUI</b></a>
Expand All @@ -142,7 +142,7 @@ <h3>Contributing a clean up options provider</h3>
up with the given options can be shown in the clean up preview tab using the method getPreview().
If the CleanUpOptions get modified in the UI, they need to be set again using the method
setOptions(...).</p>
<h3>Contributing a clean up options initializer</h3>
<h3>Contributing a Clean Up Options Initializer</h3>
<p>A clean up options initializer, which returns the default options for each clean up kind can be
created by implementing the <a href=
"../reference/api/org/eclipse/jdt/ui/cleanup/ICleanUpOptionsInitializer.html"><b>ICleanUpOptionsInitializer</b></a>.
Expand Down
8 changes: 4 additions & 4 deletions ...platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_contributing_a_quickfix.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@

</head>
<body>
<h2>Contributing a quick fix and a quick assist for Java code</h2>
<h2>Contributing a Quick Fix and a Quick Assist for Java Code</h2>
<p>The <a href="../reference/extension-points/org_eclipse_jdt_ui_quickFixProcessors.html"><b>org.eclipse.jdt.ui.quickFixProcessors</b></a> and
<a href="../reference/extension-points/org_eclipse_jdt_ui_quickAssistProcessors.html"><b>org.eclipse.jdt.ui.quickAssistProcessors</b></a>
extension points enables you to contribute your own Java code <a href="PLUGINS_ROOT/org.eclipse.jdt.doc.user/concepts/concept-quickfix-assist.htm">quick fixes and quick assists</a>.</p>

<h3>Using the extension points</h3>
<h3>Using the Extension Points</h3>
<p>To create a new extension for the extension points you need to first provide the required extensions in the plugin.xml.
For example, JDT defines the following processors</p>
<pre>
Expand All @@ -42,7 +42,7 @@ <h3>Using the extension points</h3>
<p>For a description of the individual attributes, please refer to the extension point
documentation.</p>

<h3>Contributing a quick fix and a quick assist</h3>
<h3>Contributing a Quick Fix and a Quick Assist</h3>
<p>To contribute a quick fix, you need to create the class that implements the <a href=
"../reference/api/org/eclipse/jdt/ui/text/java/IQuickFixProcessor.html"><b>IQuickFixProcessor</b></a> interface. This is the same class
that you specified in the extension declaration. Each Java problem has a unique id which is defined in <a href=
Expand All @@ -54,7 +54,7 @@ <h3>Contributing a quick fix and a quick assist</h3>
that you specified in the extension declaration.
</p>

<h3>Supplying the right IJavaCompletionProposal</h3>
<h3>Supplying the Right IJavaCompletionProposal</h3>
<p> JDT provides the following default implementations for correction proposals that can be used to contribute quick fixes and quick assists.</p>
<ul>
<li><a href="../reference/api/org/eclipse/jdt/ui/text/java/correction/ChangeCorrectionProposal.html"><b>ChangeCorrectionProposal</b></a></li>
Expand Down
6 changes: 3 additions & 3 deletions eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_editors.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@
<link rel="stylesheet" type="text/css" href="../book.css">
</head>
<body>
<h2> Customizing Java editors</h2>
<h2> Customizing Java Editors</h2>
<p>The JDT tools implement a fully-functioning Java editor.&nbsp; They also
define API so you can assign Java text editing features to your own editors or
enhance the Java editor with your plug-in specific features.</p>
<h3> Java text editing</h3>
<h3> Java Text Editing</h3>
<p><a href="../reference/api/org/eclipse/jdt/ui/text/JavaSourceViewerConfiguration.html"><b>JavaSourceViewerConfiguration</b></a>
describes the configuration for a viewer that displays Java code.&nbsp; Given a
source code viewer, this class provides access to the instances of the utility
classes that add Java specific behavior to the viewer, such as coloring,
scanning of tokens, content assist, etc.</p>
<h3> Java text hovers</h3>
<h3> Java Text Hovers</h3>
<p>When you implement a plug-in that provides additional capabilities associated
with Java code, you may want to implement new hover behavior in the editor, so
that information about your model elements will be shown as the user hovers over
Expand Down
2 changes: 1 addition & 1 deletion eclipse.platform.common/bundles/org.eclipse.jdt.doc.isv/guide/jdt_api_junit.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<link rel="stylesheet" type="text/css" href="../book.css">
</head>
<body>
<h2>Observing JUnit test runs</h2>
<h2>Observing JUnit Test Runs</h2>
<p>The JDT JUnit plug-in lets you listen to test runs. To observe test runs, register your listener with
<a href="../reference/api/org/eclipse/jdt/junit/JUnitCore.html#addTestRunListener(org.eclipse.jdt.junit.TestRunListener)">JUnitCore.addTestRunListener(TestRunListener)</a>.
</p>
Expand Down
Loading

0 comments on commit e2b5bae

Please sign in to comment.