|
1 | | -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"><html lang="en"> |
| 1 | +<!DOCTYPE HTML> |
| 2 | +<html lang="en"> |
2 | 3 | <HEAD> |
3 | 4 |
|
4 | 5 | <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2011. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > |
5 | 6 |
|
6 | | -<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> |
7 | | -<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css"> |
8 | | -<link REL="STYLESHEET" HREF="../../book.css" CHARSET="ISO-8859-1" TYPE="text/css"> |
| 7 | +<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> |
| 8 | +<link REL="STYLESHEET" HREF="../../book.css" TYPE="text/css"> |
9 | 9 | <title>Eclipse Platform API - Rules of Engagement</title> |
10 | 10 |
|
11 | 11 |
|
|
50 | 50 |
|
51 | 51 | </ul><ul> |
52 | 52 | <li> |
53 | | -<tt>org.eclipse.foo.*</tt> - for example, <tt>org.eclipse.swt.widgets</tt>, |
54 | | -<tt>org.eclipse.ui</tt>, |
55 | | -or <tt>org.eclipse.core.runtime</tt></li> |
| 53 | +<code>org.eclipse.foo.*</code> - for example, <code>org.eclipse.swt.widgets</code>, |
| 54 | +<code>org.eclipse.ui</code>, |
| 55 | +or <code>org.eclipse.core.runtime</code></li> |
56 | 56 |
|
57 | 57 | <li> |
58 | | -<tt>org.eclipse.foo.internal.*</tt> - not API; internal implementation |
| 58 | +<code>org.eclipse.foo.internal.*</code> - not API; internal implementation |
59 | 59 | packages</li> |
60 | 60 |
|
61 | 61 | <li> |
62 | | -<tt>org.eclipse.foo.examples.*</tt> - not API; these are examples</li> |
| 62 | +<code>org.eclipse.foo.examples.*</code> - not API; these are examples</li> |
63 | 63 |
|
64 | 64 | <li> |
65 | | -<tt>org.eclipse.foo.tests.*</tt> - not API; these are test suites</li> |
| 65 | +<code>org.eclipse.foo.tests.*</code> - not API; these are test suites</li> |
66 | 66 | </ul> |
67 | 67 | <ul> |
68 | 68 | <li> |
69 | | -<b>API class or interface</b> - a <tt>public</tt> class or interface in |
70 | | -an API package, or a <tt>public</tt> or <tt>protected</tt> class or interface |
| 69 | +<b>API class or interface</b> - a <code>public</code> class or interface in |
| 70 | +an API package, or a <code>public</code> or <code>protected</code> class or interface |
71 | 71 | member declared in, or inherited by, some other API class or interface. |
72 | 72 | The names of API classes and interfaces may legitimately appear in client |
73 | 73 | code.</li> |
74 | 74 |
|
75 | 75 | <li> |
76 | | -<b>API method or constructor</b> - a <tt>public</tt> or <tt>protected</tt> |
| 76 | +<b>API method or constructor</b> - a <code>public</code> or <code>protected</code> |
77 | 77 | method or constructor either declared in, or inherited by, an API class |
78 | 78 | or interface. The names of API methods may legitimately appear in client |
79 | 79 | code.</li> |
80 | 80 |
|
81 | 81 | <li> |
82 | | -<b>API field</b> - a <tt>public</tt> or <tt>protected</tt> field either |
| 82 | +<b>API field</b> - a <code>public</code> or <code>protected</code> field either |
83 | 83 | declared in, or inherited by, an API class or interface. The names of API |
84 | 84 | fields may legitimately appear in client code.</li> |
85 | 85 | </ul> |
|
168 | 168 |
|
169 | 169 | <li> |
170 | 170 | <b>Debugging methods.</b> Do not call an API method labelled "for debugging |
171 | | -purposes only". For example, most <tt>toString()</tt> methods are in this |
| 171 | +purposes only". For example, most <code>toString()</code> methods are in this |
172 | 172 | category.</li> |
173 | 173 |
|
174 | 174 | <li> |
|
184 | 184 | instances may be created. The contract may also cover things like residual |
185 | 185 | initialization responsibilities (for example, configuring a certain property |
186 | 186 | before the instance is fully active) and associated lifecycle responsibilities |
187 | | -(for example, calling <tt>dispose()</tt> to free up OS resources hung on |
| 187 | +(for example, calling <code>dispose()</code> to free up OS resources hung on |
188 | 188 | to by the instance). Classes that are designed to be instantiated by clients |
189 | 189 | are explicitly flagged in the Javadoc class comment (with words like "Clients |
190 | 190 | may instantiate."). |
|
0 commit comments