diff options
author | Peter Tribble <peter.tribble@gmail.com> | 2020-12-29 17:07:14 +0000 |
---|---|---|
committer | Peter Tribble <peter.tribble@gmail.com> | 2021-05-31 19:17:29 +0100 |
commit | 3a9318192067bc7735a0a8b261c598c7d4129177 (patch) | |
tree | e3edf8e65fea5110c0ca914e50a522626e5a3549 | |
parent | 3984682357d7bf0332a2f7d5406e349229f168e2 (diff) | |
download | illumos-gate-3a9318192067bc7735a0a8b261c598c7d4129177.tar.gz |
13318 Tidy up libdtrace_jni javadoc
Reviewed by: Toomas Soome <tsoome@me.com>
Reviewed by: Andy Fiddaman <andy@omniosce.org>
Reviewed by: Gergő Mihály Doma <domag02@gmail.com>
Approved by: Robert Mustacchi <rm@fingolfin.org>
14 files changed, 89 insertions, 117 deletions
diff --git a/usr/src/lib/libdtrace_jni/java/docs/html/fast.html b/usr/src/lib/libdtrace_jni/java/docs/html/fast.html index e5318835c8..23898130c0 100644 --- a/usr/src/lib/libdtrace_jni/java/docs/html/fast.html +++ b/usr/src/lib/libdtrace_jni/java/docs/html/fast.html @@ -2,8 +2,6 @@ Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. - ident "%Z%%M% %I% %E% SMI" - CDDL HEADER START The contents of this file are subject to the terms of the @@ -60,8 +58,8 @@ line to <tt>/etc/user_attr</tt>: <br> <br> <i>(Substitute your user name.)</i> See the <a -href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidln0?a=view> -<b>Security</b></a> chapter of the <i>Solaris Dynamic Tracing Guide</i> +href=http://dtrace.org/guide/chp-sec.html> +<b>Security</b></a> chapter of the <i>Dynamic Tracing Guide</i> for more information. <br> <h4><a name="Writing_a_Simple_Consumer"></a>Writing a Simple Consumer</h4> @@ -110,7 +108,7 @@ Here is a simple example that runs a given D script:<br> File file = new File(args[0]); String[] macroArgs = new String[args.length - 1]; System.arraycopy(args, 1, macroArgs, 0, (args.length - 1));</font> - + Consumer consumer = new LocalConsumer(); consumer.addConsumerListener(new ConsumerAdapter() { public void dataReceived(DataEvent e) { @@ -203,9 +201,9 @@ such as an aggregation:<br> <br> The above script uses the <tt>$$1</tt> macro variable as a placeholder for whatever executable you'd like to trace. See the <a -href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidliq?a=view><b> +href=http://dtrace.org/guide/chp-script.html#chp-script-3><b> Macro Arguments</b></a> section of the <b>Scripting</b> chapter of the -<i>Solaris Dynamic Tracing Guide</i>. Using two dollar signs (<tt>$$1</tt>) +<i>Dynamic Tracing Guide</i>. Using two dollar signs (<tt>$$1</tt>) instead of one (<tt>$1</tt>) forces expansion of the macro variable to type string.<br> <br> @@ -316,10 +314,10 @@ longer available to the <tt>getAggregate()</tt> method.<br> <br> Be aware that you cannot call <tt>getAggregate()</tt> on an interval faster that the <tt>aggrate</tt> setting. See the <a -href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlis?a=view> -<b>Options and Tunables</b></a> chapter of the <i>Solaris Dynamic +href=http://dtrace.org/guide/chp-opt.html> +<b>Options and Tunables</b></a> chapter of the <i>Dynamic Tracing Guide</i>. See also the <a -href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhf?a=view> +href=http://dtrace.org/guide/chp-aggs.html#chp-aggs-4> <b>Minimizing Drops</b></a> section of the <b>Aggregations</b> chapter for specific information about the <tt>aggrate</tt> option. The default <tt>aggrate</tt> is once per second. Here's an example of how you might @@ -358,9 +356,9 @@ href="../api/org/opensolaris/os/dtrace/Aggregation.html"> In addition to supporting macro arguments (see the <tt>syscall.d</tt> aggregation example above), the Java DTrace API also supports the <tt>$target</tt> macro variable. (See the <a -href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlir?a=view> +href=http://dtrace.org/guide/chp-script.html#chp-script-4> <b>Target Process ID</b></a> section of the <b>Scripting</b> chapter of -the <i>Solaris Dynamic Tracing Guide</i>.) This allows you to trace a +the <i>Dynamic Tracing Guide</i>.) This allows you to trace a process from the very beginning of its execution, rather than sometime after you manually obtain its process ID. The API does this by creating a process that is initially suspended and allowed to start only after <a @@ -485,10 +483,10 @@ href=../api/org/opensolaris/os/dtrace/PrintaRecord.html> action will not be included in the requested aggregate. <h2><a name="Learning_DTrace"></a>Learning More</h2> <br> -The <a href="http://www.opensolaris.org/os/community/dtrace/"> -OpenSolaris DTrace page</a> has links to resources to help you learn +The <a href="http://dtrace.org/"> +DTrace page</a> has links to resources to help you learn DTrace. In particular, you should read the <a -href="http://docs.sun.com/app/docs/doc/817-6223"><i>Solaris Dynamic Tracing +href="http://dtrace.org/guide/"><i>Dynamic Tracing Guide</i></a>.<br> <br> Try the example Java programs on this page with other D scripts. You diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregate.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregate.java index 7954d630a2..fb595333dc 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregate.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregate.java @@ -22,8 +22,6 @@ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -195,7 +193,7 @@ public final class Aggregate implements Serializable // team that calling getAggregation() with underbar should // return the unnamed aggregation (same as calling with empty // string). Underbar is used to identify the unnamed - // aggregation in libdtrace; in the jave API it is identifed by + // aggregation in libdtrace; in the java API it is identified by // the empty string. The API never presents underbar but // accepts it as input (just converts underbar to empty string // everywhere it sees it). @@ -230,11 +228,11 @@ public final class Aggregate implements Serializable * can easily be sorted by any arbitrary criteria, for example by * key ascending: * <pre><code> - * List <AggregationRecord> records = aggregate.getRecords(); + * List <AggregationRecord> records = aggregate.getRecords(); * Collections.sort(records, new Comparator <AggregationRecord> () { - * public int compare(AggregationRecord r1, AggregationRecord r2) { - * return r1.getTuple().compareTo(r2.getTuple()); - * } + * public int compare(AggregationRecord r1, AggregationRecord r2) { + * return r1.getTuple().compareTo(r2.getTuple()); + * } * }); * </code></pre> * Use {@code getOrderedRecords()} instead of {@code getRecords()} diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregation.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregation.java index 7a31f39c41..1883400a15 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregation.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Aggregation.java @@ -22,8 +22,6 @@ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -56,10 +54,10 @@ import java.io.*; * keyed to the empty tuple ({@link Tuple#EMPTY}). * <p> * For more information, see the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlh7?a=view> - * <b>Aggregations</b></a> chapter of the <i>Solaris Dynamic Tracing + * href=http://dtrace.org/guide/chp-aggs.html> + * <b>Aggregations</b></a> chapter of the <i>Dynamic Tracing * Guide</i>. Also, the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlfv?a=view> + * href=http://dtrace.org/guide/chp-variables.html#chp-variables-5> * <b>Built-in Variables</b></a> section of the <b>Variables</b> chapter * describes variables like {@code execname}, {@code probefunc}, and * {@code cpu} useful for aggregating. @@ -282,7 +280,7 @@ public final class Aggregation implements Serializable { * @param key The record key, or an empty tuple (see {@link * Tuple#EMPTY}) to obtain the value from a <i>singleton</i> (a * non-keyed instance with only a single value) generated from a - * DTrace aggregation declarated without square brackets, for + * DTrace aggregation declared without square brackets, for * example: * <pre> {@code @a = count();}</pre> * @return the record associated with the given key, or {@code null} diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Consumer.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Consumer.java index 59270ba21a..b732fa454d 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Consumer.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Consumer.java @@ -22,8 +22,6 @@ /* * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -76,7 +74,7 @@ public interface Consumer { * @throws NullPointerException if any of the given open flags is * {@code null} * @throws IllegalArgumentException if any of the given flags are - * mutually exlusive + * mutually exclusive * @throws IllegalStateException if this consumer is closed or has * already been opened * @throws DTraceException if an exception occurs in the native @@ -100,9 +98,9 @@ public interface Consumer { * occurrences of {@code $2}, and so on. {@code $0} is * automatically replaced by the executable name and should not be * included in the {@code macroArgs} parameter. See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidliq?a=view> + * href=http://dtrace.org/guide/chp-script.html#chp-script-3> * <b>Macro Arguments</b></a> section of the <b>Scripting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>. + * chapter of the <i>Dynamic Tracing Guide</i>. * @return a non-null {@code Program} identifier that may be passed * to {@link #enable(Program program) enable()} * @throws NullPointerException if the given program string or any @@ -129,9 +127,9 @@ public interface Consumer { * occurrences of {@code $2}, and so on. {@code $0} is * automatically set to the name of the given file and should not be * included in the {@code macroArgs} parameter. See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidliq?a=view> + * href=http://dtrace.org/guide/chp-script.html#chp-script-3> * <b>Macro Arguments</b></a> section of the <b>Scripting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>. + * chapter of the <i>Dynamic Tracing Guide</i>. * @return a non-null {@code Program} identifier that may be passed * to {@link #enable(Program program) enable()} * @throws NullPointerException if the given program file or any of @@ -259,8 +257,8 @@ public interface Consumer { * Option#switchrate switchrate} and {@link Option#aggrate aggrate} * are settable while a consumer is running; others must be set * before calling {@link #go()}. See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlis?a=view> - * <b>Options and Tunables</b></a> chapter of the <i>Solaris Dynamic + * href=http://dtrace.org/guide/chp-opt.html#chp-opt> + * <b>Options and Tunables</b></a> chapter of the <i>Dynamic Tracing * Guide</i> for information about specific options. * * @throws NullPointerException if the given option or value is @@ -392,9 +390,9 @@ public interface Consumer { * <p> * A consumer may stop on its own in response to the {@code exit()} * action (see <b>{@code exit()}</b> in the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhm?a=view> + * href=http://dtrace.org/guide/chp-actsub.html#chp-actsub-5> * <b>Special Actions</b></a> section of the <b>Actions and - * Subroutines</b> chapter of the <i>Solaris Dynamic Tracing + * Subroutines</b> chapter of the <i>Dynamic Tracing * Guide</i>). Similarly, a consumer stops automatically if it has * at least one target process and all its target processes have * completed (see {@link #createProcess(String command) @@ -491,9 +489,9 @@ public interface Consumer { * <p> * Provides a programmatic alternative to the {@code printa(}) * action (see <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhv?a=view> + * href=http://dtrace.org/guide/chp-fmt.html#chp-fmt-printa> * <b>{@code printa()}</b></a> in the <b>Output Formatting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>). + * chapter of the <i>Dynamic Tracing Guide</i>). * * @throws IllegalStateException if called before {@link #go()} or * after {@link #close()} @@ -511,9 +509,9 @@ public interface Consumer { * <p> * Provides a programmatic alternative to the {@code printa(}) * action (see <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhv?a=view> + * href=http://dtrace.org/guide/chp-fmt.html#chp-fmt-printa> * <b>{@code printa()}</b></a> in the <b>Output Formatting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>). + * chapter of the <i>Dynamic Tracing Guide</i>). * * @param includedAggregationNames if {@code null}, all available * aggregations are included; if non-null, only those aggregations @@ -542,9 +540,9 @@ public interface Consumer { * <p> * Provides a programmatic alternative to the {@code printa(}) (see * <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhv?a=view> + * href=http://dtrace.org/guide/chp-fmt.html#chp-fmt-printa> * <b>{@code printa()}</b></a> in the <b>Output Formatting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>) and {@code + * chapter of the <i>Dynamic Tracing Guide</i>) and {@code * clear()} actions. * * @param includedAggregationNames if {@code null}, all available @@ -574,15 +572,15 @@ public interface Consumer { * processStateChanged()} method. * <p> * See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlir?a=view> + * href=http://dtrace.org/guide/chp-script.html#chp-script-4> * <b>Target Process ID</b></a> section of the <b>Scripting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>. + * chapter of the <i>Dynamic Tracing Guide</i>. * * @param command a string whose first token is assumed to be the * name of the command and whose subsequent tokens are the arguments * to that command. * @return ID of the created process (pid) - * @throws NullPointerException if the given command is {@code nul}l + * @throws NullPointerException if the given command is {@code null} * @throws IllegalArgumentException if the given command is empty or * contains only whitespace * @throws IllegalStateException if called before {@link @@ -602,9 +600,9 @@ public interface Consumer { * processStateChanged()} method. * <p> * See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlir?a=view> + * href=http://dtrace.org/guide/chp-script.html#chp-script-4> * <b>Target Process ID</b></a> section of the <b>Scripting</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>. + * chapter of the <i>Dynamic Tracing Guide</i>. * * @param pid process ID of the process to be grabbed * @throws IllegalStateException if called before {@link diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ConsumerListener.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ConsumerListener.java index 7d0ffed97a..ab8d93cbc1 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ConsumerListener.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ConsumerListener.java @@ -22,8 +22,6 @@ /* * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -94,9 +92,9 @@ public interface ConsumerListener extends EventListener { * request (by calling {@link Consumer#stop()} or {@link * Consumer#abort()}), terminated normally as a result of the DTrace * {@code exit()} action (see <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhm?a=view> - * <tt>exit()</tt></a> in the <b>Special Actions</b> section of the - * <b>Actions and Subroutines</b> chapter of the <i>Solaris Dynamic + * href=http://dtrace.org/guide/chp-actsub.html#chp-actsub-5> + * <b>{@code exit()}</b></a> in the <b>Special Actions</b> section of the + * <b>Actions and Subroutines</b> chapter of the <i>Dynamic * Tracing Guide</i>) or after the completion of all target * processes, or terminated abnormally because of an exception. It * is necessary to call {@link Consumer#close()} to release any diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Flow.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Flow.java index 7a0fbfb906..7db42fa86f 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Flow.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Flow.java @@ -22,8 +22,6 @@ /* * Copyright 2007 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -42,9 +40,9 @@ import java.beans.*; * ... * </code></pre> * See the <a - * href="http://docs.sun.com/app/docs/doc/817-6223/6mlkidlk1?a=view"> + * href="http://dtrace.org/guide/chp-fbt.html#chp-fbt-10"> * <b>Examples</b></a> section of the <b>{@code fbt} - * Provider</b> chapter of the <i>Solaris Dynamic Tracing Guide</i>. + * Provider</b> chapter of the <i>Dynamic Tracing Guide</i>. * <p> * Immutable. Supports persistence using {@link java.beans.XMLEncoder}. * diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/InterfaceAttributes.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/InterfaceAttributes.java index 226458745f..80f14e5ba6 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/InterfaceAttributes.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/InterfaceAttributes.java @@ -22,8 +22,6 @@ /* * Copyright 2007 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -38,8 +36,8 @@ import java.beans.*; * of future releases. The D compiler includes features to dynamically * compute the stability levels of D programs you create. For more * information, refer to the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlnp?a=view> - * <b>Stability</b></a> chapter of the <i>Solaris Dynamic Tracing + * href=http://dtrace.org/guide/chp-stab.html> + * <b>Stability</b></a> chapter of the <i>Dynamic Tracing * Guide</i>. * <p> * Immutable. Supports persistence using {@link java.beans.XMLEncoder}. @@ -149,7 +147,7 @@ public final class InterfaceAttributes implements Serializable { /** * The interface might eventually become Standard or Stable but * is still in transition. Sun will make reasonable efforts to - * ensure compatibility with previous releases as it eveolves. + * ensure compatibility with previous releases as it evolves. * When non-upward compatible changes become necessary, they * will occur in minor and major releases. These changes will * be avoided in micro releases whenever possible. If such a @@ -209,7 +207,7 @@ public final class InterfaceAttributes implements Serializable { /** * Architectural dependency class. Tells whether an interface is - * common to all Solaris platforms and processors, or whether the + * common to all platforms and processors, or whether the * interface is associated with a particular architecture such as * SPARC processors only. */ @@ -271,17 +269,17 @@ public final class InterfaceAttributes implements Serializable { * instruction sets supported by the system using the {@code * isainfo(1)} utility. The interface might not be supported on * systems that do not export any of of the same instruction - * sets. For example, an ISA-dependent interface on a Solaris - * SPARC system might not be supported on a Solaris x86 system. + * sets. For example, an ISA-dependent interface on a + * SPARC system might not be supported on an x86 system. */ ISA("ISA"), /** - * The interface is common to all Solaris systems regardless of the + * The interface is common to all systems regardless of the * underlying hardware. DTrace programs and layered applications that * depend only on Common interfaces can be executed and deployed on - * other Solaris systems with the same Solaris and DTrace revisions. + * other systems with the same illumos and DTrace revisions. * The majority of DTrace interfaces are Common, so you can use them - * wherever you use Solaris. + * wherever you use illumos. */ COMMON("Common"); @@ -379,7 +377,7 @@ public final class InterfaceAttributes implements Serializable { } /** - * Gets the stabiltiy level of an interface associated with its name + * Gets the stability level of an interface associated with its name * as it appears in a D program. For example, the {@code execname} * D variable is a {@link Stability#STABLE STABLE} name: Sun * guarantees this identifier will continue to be supported in D @@ -407,7 +405,7 @@ public final class InterfaceAttributes implements Serializable { * Gets the stability level of the data format used by an interface * and any associated data semantics. For example, the {@code pid} * D variable is a {@link Stability#STABLE STABLE} interface: - * process IDs are a stable concept in Solaris, and Sun guarantees + * process IDs are a stable concept in illumos, and it is guaranteed * that the {@code pid} variable will be of type {@code pid_t} with * the semantic that it is set to the process ID corresponding to * the thread that fired a given probe in accordance with the rules @@ -510,9 +508,9 @@ public final class InterfaceAttributes implements Serializable { /** * Gets the string representation of this triplet of interface * attributes. The format follows the convention described in the - * <a href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlnt?a=view> + * <a href=http://dtrace.org/guide/chp-stab.html#chp-stab-3> * <b>Interface Attributes</b></a> section of the <b>Stability</b> - * chapter of the <i>Solaris Dynamic Tracing Guide</i>. The + * chapter of the <i>Dynamic Tracing Guide</i>. The * attributes appear in the following order, separated by slashes: * <pre><code> * <i>name-stability / data-stability / dependency-class</i> diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/LocalConsumer.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/LocalConsumer.java index 65dc65e38d..d1506e3408 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/LocalConsumer.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/LocalConsumer.java @@ -680,7 +680,7 @@ public class LocalConsumer implements Consumer { * } * </code></pre> * Or if you need to create your own thread: - * <pre></code> + * <pre><code> * protected Thread * createThread() * { @@ -711,7 +711,7 @@ public class LocalConsumer implements Consumer { } /** - * @inheritDoc + * {@inheritDoc} * @throws IllegalThreadStateException if a subclass calls {@link * Thread#start()} on the value of {@link #createThread()} * @see #createThread() @@ -723,7 +723,7 @@ public class LocalConsumer implements Consumer { } /** - * @inheritDoc + * {@inheritDoc} * @throws IllegalThreadStateException if a subclass calls {@link * Thread#start()} on the value of {@link #createThread()} * @see #createThread() @@ -765,7 +765,7 @@ public class LocalConsumer implements Consumer { } /** - * @inheritDoc + * {@inheritDoc} * * @throws IllegalThreadStateException if attempting to {@code * stop()} a running consumer while holding the lock on that @@ -876,7 +876,7 @@ public class LocalConsumer implements Consumer { } /** - * @inheritDoc + * {@inheritDoc} * * @throws IllegalThreadStateException if attempting to {@code * close()} a running consumer while holding the lock on that diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Option.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Option.java index a401068400..67f896cff9 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Option.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/Option.java @@ -22,8 +22,6 @@ /* * Copyright 2007 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -44,8 +42,8 @@ import java.beans.*; * is running. * <p> * See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlis?a=view> - * <b>Options and Tunables</b></a> chapter of the <i>Solaris Dynamic + * href=http://dtrace.org/guide/chp-opt.html> + * <b>Options and Tunables</b></a> chapter of the <i>Dynamic * Tracing Guide</i>. * <p> * Immutable. Supports persistence using {@link java.beans.XMLEncoder}. @@ -304,17 +302,17 @@ public final class Option implements Serializable { public static final String VALUE_UNSET = "unset"; /** - * {@link #bufpolicy} value: use {@code ring} princical buffer + * {@link #bufpolicy} value: use {@code ring} principal buffer * policy. */ public static final String VALUE_RING = "ring"; /** - * {@link #bufpolicy} value: use {@code fill} princical buffer + * {@link #bufpolicy} value: use {@code fill} principal buffer * policy. */ public static final String VALUE_FILL = "fill"; /** - * {@link #bufpolicy} default value: use {@code switch} princical + * {@link #bufpolicy} default value: use {@code switch} principal * buffer policy. */ public static final String VALUE_SWITCH = "switch"; @@ -369,7 +367,7 @@ public final class Option implements Serializable { */ public static final String defaultargs = "defaultargs"; /** - * Define symbol when invoking preprocssor (compile-time). + * Define symbol when invoking preprocessor (compile-time). */ public static final String define = "define"; /** @@ -484,9 +482,9 @@ public final class Option implements Serializable { * #VALUE_FILL fill}, or {@link #VALUE_RING ring}). Runtime option. * <p> * See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhr?a=view> + * href=http://dtrace.org/guide/chp-buf.html#chp-buf-2> * <b>Principal Buffer Policies</b></a> section of the - * <b>Buffers and Buffering</b> chapter of the <i>Solaris Dynamic + * <b>Buffers and Buffering</b> chapter of the <i>Dynamic * Tracing Guide</i>. */ public static final String bufpolicy = "bufpolicy"; @@ -495,9 +493,9 @@ public final class Option implements Serializable { * #VALUE_MANUAL manual}). Runtime option. * <p> * See the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlhu?a=view> + * href=http://dtrace.org/guide/chp-buf.html#chp-buf-5> * <b>Buffer Resizing Policy</b></a> section of the <b>Buffers - * and Buffering</b> chapter of the <i>Solaris Dynamic Tracing + * and Buffering</b> chapter of the <i>Dynamic Tracing * Guide</i>. */ public static final String bufresize = "bufresize"; diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintaRecord.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintaRecord.java index 616a955223..fd5fa7bc38 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintaRecord.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintaRecord.java @@ -22,8 +22,6 @@ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -67,9 +65,9 @@ import java.util.*; * no aggregation data. However, the formatted output generated by the * DTrace library is available in all cases. For details about * {@code printa()} format strings, see the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidli3?a=view> + * href=http://dtrace.org/guide/chp-fmt.html#chp-fmt-printa> * <b>{@code printa()}</b></a> section of the <b>Output - * Formatting</b> chapter of the <i>Solaris Dynamic Tracing Guide</i>. + * Formatting</b> chapter of the <i>Dynamic Tracing Guide</i>. * <p> * Immutable. Supports persistence using {@link java.beans.XMLEncoder}. * @@ -523,7 +521,7 @@ public final class PrintaRecord implements Record, Serializable, copy.addAll(tuples); tuples = copy; } - // check constructor invariants only after defensize copy + // check constructor invariants only after defensive copy try { validate(); } catch (Exception e) { diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintfRecord.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintfRecord.java index e2aee1bce7..26cb8608e5 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintfRecord.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/PrintfRecord.java @@ -22,8 +22,6 @@ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -156,7 +154,7 @@ public final class PrintfRecord implements Record, Serializable, } /** - * Gets the unfomatted elements passed to the DTrace {@code + * Gets the unformatted elements passed to the DTrace {@code * printf()} action after the format string. * * @return non-null, unmodifiable list of unformatted elements @@ -198,7 +196,7 @@ public final class PrintfRecord implements Record, Serializable, * printf()} element at the given index (using the same order that * they appear in the {@code printf()} argument list) * @throws ArrayIndexOutOfBoundsException if the given index is - * out of range (index < 0 || index >= getRecordCount()) + * out of range (index < 0 || index >= getRecordCount()) */ public ValueRecord getRecord(int i) diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ProbeData.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ProbeData.java index a579ade0e1..e033fac799 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ProbeData.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/ProbeData.java @@ -22,8 +22,6 @@ /* * Copyright 2008 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -61,9 +59,9 @@ import java.beans.*; * Currently the {@code ProbeData} instance does not record a timestamp. * If you need a timestamp, trace the built-in {@code timestamp} * variable in your D program. (See the - * <a href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidlfv?a=view> + * <a href=http://dtrace.org/guide/chp-variables.html#chp-variables-5> * <b>Built-in Variables</b></a> section of the <b>Variables</b> chapter of - * the <i>Solaris Dynamic Tracing Guide</i>). + * the <i>Dynamic Tracing Guide</i>). * <p> * Immutable. Supports persistence using {@link java.beans.XMLEncoder}. * diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/StackValueRecord.java b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/StackValueRecord.java index 682fe6b81c..7b1e89d8d4 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/StackValueRecord.java +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/StackValueRecord.java @@ -22,8 +22,6 @@ /* * Copyright 2006 Sun Microsystems, Inc. All rights reserved. * Use is subject to license terms. - * - * ident "%Z%%M% %I% %E% SMI" */ package org.opensolaris.os.dtrace; @@ -46,9 +44,9 @@ public interface StackValueRecord extends ValueRecord { * (The {@code stack()}, {@code ustack()}, and {@code jstack()} * actions are all usable as members of an aggregation tuple.) See * the <a - * href=http://docs.sun.com/app/docs/doc/817-6223/6mlkidli3?a=view> + * href=http://dtrace.org/guide/chp-fmt.html#chp-fmt-printa> * <b>{@code printa()}</b></a> section of the <b>Output - * Formatting</b> chapter of the <i>Solaris Dynamic Tracing + * Formatting</b> chapter of the <i>Dynamic Tracing * Guide</i> for details about {@code printa()} format strings. * Human-readable stack frames are generated by default if {@code * printa()} is called without specifying a format string, or when diff --git a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/package.html b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/package.html index 9ca357a440..7b8d77c17c 100644 --- a/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/package.html +++ b/usr/src/lib/libdtrace_jni/java/src/org/opensolaris/os/dtrace/package.html @@ -2,8 +2,6 @@ Copyright 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. - ident "%Z%%M% %I% %E% SMI" - CDDL HEADER START The contents of this file are subject to the terms of the @@ -27,13 +25,13 @@ <html> <head/> <body bgcolor="white"> - + Interface to the native DTrace library. - + <!-- commented out ... <h2>Package Specification</h2> - + ##### FILL IN ANY SPECS NEEDED BY JAVA COMPATIBILITY KIT ##### <ul> @@ -47,10 +45,8 @@ end commented-out block --> For overviews, tutorials, examples, guides, and tool documentation, please see: <br><br> -<a href="http://docs.sun.com/app/docs/doc/817-6223"> - <i>Solaris Dynamic Tracing Guide</i></a><br> -<a href="http://www.opensolaris.org/os/community/dtrace"> - OpenSolaris DTrace Website</a><br> +<a href="http://dtrace.org/guide/"> + <i>Dynamic Tracing Guide</i></a><br> <a href="../../../../../html/JavaDTraceAPI.html" target="parent"> API Diagram</a><br> <a href="../../../../../html/fast.html" target="parent"> |