annotate src/bsd/doc/man/apt.1 @ 1245:4fef42eb432c

Merge jdk7-b58 from main OpenJDK repository.
author kurt
date Wed, 20 May 2009 12:01:48 -0400
parents 5df63dc24cfe
children 8356c7fa1a33
rev   line source
mr@489 1 ." Copyright 2004-2006 Sun Microsystems, Inc. All Rights Reserved.
mr@489 2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
mr@489 3 ."
mr@489 4 ." This code is free software; you can redistribute it and/or modify it
mr@489 5 ." under the terms of the GNU General Public License version 2 only, as
mr@489 6 ." published by the Free Software Foundation.
mr@489 7 ."
mr@489 8 ." This code is distributed in the hope that it will be useful, but WITHOUT
mr@489 9 ." ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
mr@489 10 ." FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
mr@489 11 ." version 2 for more details (a copy is included in the LICENSE file that
mr@489 12 ." accompanied this code).
mr@489 13 ."
mr@489 14 ." You should have received a copy of the GNU General Public License version
mr@489 15 ." 2 along with this work; if not, write to the Free Software Foundation,
mr@489 16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
mr@489 17 ."
mr@489 18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
mr@489 19 ." CA 95054 USA or visit www.sun.com if you need additional information or
mr@489 20 ." have any questions.
kurt@1245 21 ."
kurt@1245 22 .TH apt 1 "04 May 2009"
kurt@1245 23 ." Generated from HTML by html2man (author: Eric Armstrong)
mr@489 24
mr@489 25 .LP
mr@489 26 .SH "NAME"
mr@489 27 .LP
mr@489 28 .LP
mr@489 29 \f2apt\fP \- annotation processing tool
mr@489 30 .LP
mr@489 31 .SH "SYNOPSIS"
mr@489 32 .LP
mr@489 33 .LP
mr@489 34 \f2apt [\-classpath \fP\f2classpath\fP] [\-sourcepath \f2sourcepath\fP] [\-d \f2directory\fP] [\-s \f2directory\fP] [\-factorypath \f2path\fP] [\-factory \f2class\fP] [\-print] [\-nocompile] [\-A\f2key\fP[\f2=val\fP] ...] [\f2javac option\fP] sourcefiles [@files]
mr@489 35 .LP
mr@489 36 .SH "PARAMETERS"
mr@489 37 .LP
mr@489 38 .LP
mr@489 39 Options may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
mr@489 40 .LP
kurt@1245 41 .RS 3
mr@489 42 .TP 3
mr@489 43 sourcefiles
mr@489 44 Zero or more source files to be processed.
mr@489 45 .TP 3
mr@489 46 @files
mr@489 47 One or more files that list source files or other options
kurt@1245 48 .RE
kurt@1245 49
mr@489 50 .LP
mr@489 51 .SH "DESCRIPTION"
mr@489 52 .LP
mr@489 53 .LP
mr@489 54 The tool \f2apt\fP, annotation processing tool, includes a set of new reflective APIs and supporting infrastructure to process program annotations. The \f2apt\fP reflective APIs provide a build\-time, source\-based, read\-only view of program structure. These reflective APIs are designed to cleanly model the Java(TM) programming language's type system after the addition of generics. First, \f2apt\fP runs annotation processors that can produce new source code and other files. Next, \f2apt\fP can cause compilation of both original and generated source files, easing development. The reflective APIs and other APIs used to interact with the tool are subpackages of \f2com.sun.mirror\fP.
mr@489 55 .LP
mr@489 56 .LP
mr@489 57 A fuller discussion of how the tool operates as well as instructions for developing with \f2apt\fP are in
mr@489 58 .na
mr@489 59 \f4Getting Started with \fP\f4apt\fP. @
mr@489 60 .fi
mr@489 61 http://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html
mr@489 62 .LP
kurt@1245 63 .RS 3
mr@489 64 .TP 3
mr@489 65 Note:
kurt@1245 66 \f2The functionality of \fP\f2apt\fP has been subsumed by the annotation\-processing infrastructure that is now part of the \f2javac(1)\fP tool and standardized for use by all Java compilers. This new infrastructure relies on the language model and annotation\-processing APIs that are now part of the Java Platform. It is recommended that new annotation processor development be based on the new APIs and the \f2javac\fP tool.
kurt@1245 67 .RE
kurt@1245 68
mr@489 69 .LP
mr@489 70 .SH "OPTIONS"
mr@489 71 .LP
mr@489 72 .SS
mr@489 73 apt specific options
mr@489 74 .LP
kurt@1245 75 .RS 3
mr@489 76 .TP 3
mr@489 77 \-s dir
mr@489 78 Specify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace.
mr@489 79 .TP 3
mr@489 80 \-nocompile
mr@489 81 Do not compile source files to class files.
mr@489 82 .TP 3
mr@489 83 \-print
mr@489 84 Print out textual representation of specified types; perform no annotation processing or compilation.
mr@489 85 .TP 3
mr@489 86 \-A[key[=val]]
mr@489 87 Options to pass to annotation processors \-\- these are not interpreted by \f2apt\fP directly, but are made available for use by individual processors
mr@489 88 .TP 3
mr@489 89 \-factorypath path
mr@489 90 Specify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories.
mr@489 91 .TP 3
mr@489 92 \-factory classname
mr@489 93 Name of annotation processor factory to use; bypasses default discovery process
kurt@1245 94 .RE
kurt@1245 95
mr@489 96 .LP
mr@489 97 .SS
mr@489 98 Options shared with javac
mr@489 99 .LP
kurt@1245 100 .RS 3
mr@489 101 .TP 3
mr@489 102 \-d dir
mr@489 103 Specify where to place processor and javac generated class files
mr@489 104 .TP 3
kurt@1245 105 \-cp path or \-classpath path
mr@489 106 Specify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories.
kurt@1245 107 .RE
kurt@1245 108
mr@489 109 .LP
mr@489 110 .LP
mr@489 111 Consult the javac(1) man page for information on \f2javac\fP options.
mr@489 112 .LP
mr@489 113 .SH "NOTES"
mr@489 114 .LP
mr@489 115 .LP
mr@489 116 The functionality of \f2apt\fP has been subsumed by the standard annotation\-processing infrastructure now offered by \f2javac\fP. Support for \f2apt\fP and its associated APIs may be discontinued in some future JDK release.
mr@489 117 .LP
mr@489 118 .SH "SEE ALSO"
mr@489 119 .LP
mr@489 120 .RS 3
mr@489 121 .TP 2
kurt@1245 122 o
kurt@1245 123 javac(1), java(1)
mr@489 124 .RE
mr@489 125
mr@489 126 .LP
kurt@1245 127
kurt@1245 128 .LP
mr@489 129