jdk/src/solaris/doc/sun/man/man1/apt.1
changeset 2692 345bc8d65b19
parent 2 90ce3da70b43
child 5506 202f599c92aa
equal deleted inserted replaced
2691:bad7bbf42755 2692:345bc8d65b19
     1 .'" t
     1 ." Copyright 2004-2006 Sun Microsystems, Inc.  All Rights Reserved.
     2 ." Copyright 2006 Sun Microsystems, Inc.  All Rights Reserved.
       
     3 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2 ." DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4 ."
     3 ."
     5 ." This code is free software; you can redistribute it and/or modify it
     4 ." This code is free software; you can redistribute it and/or modify it
     6 ." under the terms of the GNU General Public License version 2 only, as
     5 ." under the terms of the GNU General Public License version 2 only, as
     7 ." published by the Free Software Foundation.
     6 ." published by the Free Software Foundation.
    17 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    16 ." Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
    18 ."
    17 ."
    19 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    18 ." Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
    20 ." CA 95054 USA or visit www.sun.com if you need additional information or
    19 ." CA 95054 USA or visit www.sun.com if you need additional information or
    21 ." have any questions.
    20 ." have any questions.
    22 ." ` 
    21 ."
    23 .TH apt 1 "05 Aug 2006"
    22 .TH apt 1 "04 May 2009"
    24 ." Generated by html2roff
    23 ." Generated from HTML by html2man (author: Eric Armstrong)
    25 
    24 
    26 .LP
    25 .LP
    27 .SH "NAME"
    26 .SH "NAME"
    28 .LP
    27 .LP
    29 .LP
    28 .LP
    37 .SH "PARAMETERS"
    36 .SH "PARAMETERS"
    38 .LP
    37 .LP
    39 .LP
    38 .LP
    40 Options may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
    39 Options may be in any order. For a discussion of parameters which apply to a specific option, see OPTIONS below.
    41 .LP
    40 .LP
       
    41 .RS 3
    42 .TP 3
    42 .TP 3
    43 sourcefiles 
    43 sourcefiles 
    44 Zero or more source files to be processed. 
    44 Zero or more source files to be processed. 
    45 .TP 3
    45 .TP 3
    46 @files 
    46 @files 
    47 One or more files that list source files or other options 
    47 One or more files that list source files or other options 
       
    48 .RE
       
    49 
    48 .LP
    50 .LP
    49 .SH "DESCRIPTION"
    51 .SH "DESCRIPTION"
    50 .LP
    52 .LP
    51 .LP
    53 .LP
    52 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.
    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.
    56 .na
    58 .na
    57 \f4Getting Started with \fP\f4apt\fP. @
    59 \f4Getting Started with \fP\f4apt\fP. @
    58 .fi
    60 .fi
    59 http://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html
    61 http://java.sun.com/javase/6/docs/technotes/guides/apt/GettingStarted.html
    60 .LP
    62 .LP
       
    63 .RS 3
    61 .TP 3
    64 .TP 3
    62 Note: 
    65 Note: 
    63 \f2The functionality of \fP\f2apt\fP has been subsumed by the annotation\-processing infrastructure that is now part of the \f2javac\fP tool [
    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. 
    64 .na
    67 .RE
    65 \f2Solaris and Linux\fP @
    68 
    66 .fi
       
    67 http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html] [Windows] 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. 
       
    68 .LP
    69 .LP
    69 .SH "OPTIONS"
    70 .SH "OPTIONS"
    70 .LP
    71 .LP
    71 .SS 
    72 .SS 
    72 apt specific options
    73 apt specific options
    73 .LP
    74 .LP
       
    75 .RS 3
    74 .TP 3
    76 .TP 3
    75 \-s dir 
    77 \-s dir 
    76 Specify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace. 
    78 Specify the directory root under which processor\-generated source files will be placed; files are placed in subdirectories based on package namespace. 
    77 .TP 3
    79 .TP 3
    78 \-nocompile 
    80 \-nocompile 
    87 \-factorypath path 
    89 \-factorypath path 
    88 Specify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories. 
    90 Specify where to find annotation processor factories; if this option is used, the classpath is \f2not\fP searched for factories. 
    89 .TP 3
    91 .TP 3
    90 \-factory classname 
    92 \-factory classname 
    91 Name of annotation processor factory to use; bypasses default discovery process 
    93 Name of annotation processor factory to use; bypasses default discovery process 
       
    94 .RE
       
    95 
    92 .LP
    96 .LP
    93 .SS 
    97 .SS 
    94 Options shared with javac
    98 Options shared with javac
    95 .LP
    99 .LP
       
   100 .RS 3
    96 .TP 3
   101 .TP 3
    97 \-d dir 
   102 \-d dir 
    98 Specify where to place processor and javac generated class files 
   103 Specify where to place processor and javac generated class files 
    99 .TP 3
   104 .TP 3
   100 \-cp path or \-classpath
   105 \-cp path or \-classpath path 
   101 path 
       
   102 Specify where to find user class files and annotation processor factories. If \f2\-factorypath\fP is given, the classpath is not searched for factories. 
   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. 
       
   107 .RE
       
   108 
   103 .LP
   109 .LP
   104 .LP
   110 .LP
   105 Consult the javac(1) man page for information on \f2javac\fP options.
   111 Consult the javac(1) man page for information on \f2javac\fP options.
   106 .LP
   112 .LP
   107 .SH "NOTES"
   113 .SH "NOTES"
   111 .LP
   117 .LP
   112 .SH "SEE ALSO"
   118 .SH "SEE ALSO"
   113 .LP
   119 .LP
   114 .RS 3
   120 .RS 3
   115 .TP 2
   121 .TP 2
   116 *
   122 o
   117 javac: [
   123 javac(1), java(1) 
   118 .na
       
   119 \f2Solaris and Linux\fP @
       
   120 .fi
       
   121 http://java.sun.com/javase/6/docs/technotes/tools/solaris/javac.html] [Windows] 
       
   122 .TP 2
       
   123 *
       
   124 java: [
       
   125 .na
       
   126 \f2Solaris\fP @
       
   127 .fi
       
   128 http://java.sun.com/javase/6/docs/technotes/tools/solaris/java.html] [
       
   129 .na
       
   130 \f2Linux\fP @
       
   131 .fi
       
   132 http://java.sun.com/javase/6/docs/technotes/tools/linux/java.html] [Windows] 
       
   133 .RE
   124 .RE
   134 
   125 
   135 .LP
   126 .LP
       
   127 
       
   128 .LP
   136  
   129