Ignore:
Timestamp:
02/06/12 11:21:48 (9 years ago)
Author:
rschlatte
Message:

Manual: fix grovel.lisp, add to Makefile (not run by default)

... also create new versions of generated files.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/abcl/doc/manual/java.tex

    r13690 r13858  
    1 \subsection{Exported Symbols from the JAVA package}
    21\paragraph{}
    32\label{JAVA:JAVA-EXCEPTION-CAUSE}
    … …  
    65
    76\begin{adjustwidth}{5em}{5em}
    8 Returns the cause of JAVA-EXCEPTION. (The cause is the Java Throwable
    9   object that caused JAVA-EXCEPTION to be signalled.)
     7not-documented
    108\end{adjustwidth}
    119
    … …  
    4543
    4644\begin{adjustwidth}{5em}{5em}
    47 NOT-DOCUMENTED
     45not-documented
    4846\end{adjustwidth}
    4947
    … …  
    8583
    8684\paragraph{}
     85\label{JAVA:JINSTANCE-OF-P}
     86\index{JINSTANCE-OF-P}
     87--- Function: \textbf{jinstance-of-p} [\textbf{java}] \textit{obj class}
     88
     89\begin{adjustwidth}{5em}{5em}
     90OBJ is an instance of CLASS (or one of its subclasses)
     91\end{adjustwidth}
     92
     93\paragraph{}
     94\label{JAVA:JSTATIC-RAW}
     95\index{JSTATIC-RAW}
     96--- Function: \textbf{jstatic-raw} [\textbf{java}] \textit{method class \&rest args}
     97
     98\begin{adjustwidth}{5em}{5em}
     99Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
     100\end{adjustwidth}
     101
     102\paragraph{}
     103\label{JAVA:DEFINE-JAVA-CLASS}
     104\index{DEFINE-JAVA-CLASS}
     105--- Macro: \textbf{define-java-class} [\textbf{java}] \textit{}
     106
     107\begin{adjustwidth}{5em}{5em}
     108not-documented
     109\end{adjustwidth}
     110
     111\paragraph{}
     112\label{JAVA:JCLASS-OF}
     113\index{JCLASS-OF}
     114--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
     115
     116\begin{adjustwidth}{5em}{5em}
     117not-documented
     118\end{adjustwidth}
     119
     120\paragraph{}
    87121\label{JAVA:JRUN-EXCEPTION-PROTECTED}
    88122\index{JRUN-EXCEPTION-PROTECTED}
    … …  
    94128
    95129\paragraph{}
    96 \label{JAVA:JINSTANCE-OF-P}
    97 \index{JINSTANCE-OF-P}
    98 --- Function: \textbf{jinstance-of-p} [\textbf{java}] \textit{obj class}
    99 
    100 \begin{adjustwidth}{5em}{5em}
    101 OBJ is an instance of CLASS (or one of its subclasses)
    102 \end{adjustwidth}
    103 
    104 \paragraph{}
    105130\label{JAVA:JMETHOD-NAME}
    106131\index{JMETHOD-NAME}
    … …  
    112137
    113138\paragraph{}
    114 \label{JAVA:JSTATIC-RAW}
    115 \index{JSTATIC-RAW}
    116 --- Function: \textbf{jstatic-raw} [\textbf{java}] \textit{method class \&rest args}
    117 
    118 \begin{adjustwidth}{5em}{5em}
    119 Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
    120 \end{adjustwidth}
    121 
    122 \paragraph{}
    123 \label{JAVA:JCLASS-OF}
    124 \index{JCLASS-OF}
    125 --- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
    126 
    127 \begin{adjustwidth}{5em}{5em}
    128 Returns the name of the Java class of OBJECT. If the NAME argument is
    129   supplied, verifies that OBJECT is an instance of the named class. The name
    130   of the class or nil is always returned as a second value.
    131 \end{adjustwidth}
    132 
    133 \paragraph{}
    134139\label{JAVA:GET-CURRENT-CLASSLOADER}
    135140\index{GET-CURRENT-CLASSLOADER}
    … …  
    137142
    138143\begin{adjustwidth}{5em}{5em}
    139 NOT-DOCUMENTED
    140 \end{adjustwidth}
    141 
     144not-documented
     145\end{adjustwidth}
     146
     147\paragraph{}
     148\label{JAVA:JGET-PROPERTY-VALUE}
     149\index{JGET-PROPERTY-VALUE}
     150--- Function: \textbf{\%jget-property-value} [\textbf{java}] \textit{java-object property-name}
     151
     152\begin{adjustwidth}{5em}{5em}
     153Gets a JavaBeans property on JAVA-OBJECT.
     154SYSTEM-INTERNAL: Use jproperty-value instead.
     155\end{adjustwidth}
    142156
    143157\paragraph{}
    … …  
    147161
    148162\begin{adjustwidth}{5em}{5em}
    149 NOT-DOCUMENTED
     163not-documented
    150164\end{adjustwidth}
    151165
    … …  
    165179
    166180\begin{adjustwidth}{5em}{5em}
    167 NOT-DOCUMENTED
     181not-documented
    168182\end{adjustwidth}
    169183
    … …  
    201215
    202216\begin{adjustwidth}{5em}{5em}
    203 NOT-DOCUMENTED
     217not-documented
     218\end{adjustwidth}
     219
     220\paragraph{}
     221\label{JAVA:JSET-PROPERTY-VALUE}
     222\index{JSET-PROPERTY-VALUE}
     223--- Function: \textbf{\%jset-property-value} [\textbf{java}] \textit{java-object property-name value}
     224
     225\begin{adjustwidth}{5em}{5em}
     226Sets a JavaBean property on JAVA-OBJECT.
     227SYSTEM-INTERNAL: Use (setf jproperty-value) instead.
    204228\end{adjustwidth}
    205229
    … …  
    216240\label{JAVA:JNEW-RUNTIME-CLASS}
    217241\index{JNEW-RUNTIME-CLASS}
    218 --- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{}
    219 
    220 \begin{adjustwidth}{5em}{5em}
    221 NOT-DOCUMENTED
     242--- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{class-name \&rest args \&key (superclass java.lang.Object) interfaces constructors methods fields (access-flags (quote (public))) annotations}
     243
     244\begin{adjustwidth}{5em}{5em}
     245Creates and loads a Java class with methods calling Lisp closures
     246   as given in METHODS.  CLASS-NAME and SUPER-NAME are strings,
     247   INTERFACES is a list of strings, CONSTRUCTORS, METHODS and FIELDS are
     248   lists of constructor, method and field definitions.
     249
     250   Constructor definitions - currently NOT supported - are lists of the form
     251   (argument-types function \&optional super-invocation-arguments)
     252   where argument-types is a list of strings and function is a lisp function of
     253   (1+ (length argument-types)) arguments; the instance (`this') is passed in as
     254   the last argument. The optional super-invocation-arguments is a list of numbers
     255   between 1 and (length argument-types), where the number k stands for the kth argument
     256   to the just defined constructor. If present, the constructor of the superclass
     257   will be called with the appropriate arguments. E.g., if the constructor definition is
     258   (("java.lang.String" "int") \#'(lambda (string i this) ...) (2 1))
     259   then the constructor of the superclass with argument types (int, java.lang.String) will
     260   be called with the second and first arguments.
     261
     262   Method definitions are lists of the form
     263   (method-name return-type argument-types function \&key modifiers annotations)
     264   where method-name is a string, return-type and argument-types are strings or keywords for
     265   primitive types (:void, :int, etc.), and function is a Lisp function of minimum arity
     266   (1+ (length argument-types)); the instance (`this') is passed in as the first argument.
     267
     268   Field definitions are lists of the form (field-name type \&key modifiers annotations).
    222269\end{adjustwidth}
    223270
    … …  
    250297
    251298\paragraph{}
     299\label{JAVA:JNEW}
     300\index{JNEW}
     301--- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
     302
     303\begin{adjustwidth}{5em}{5em}
     304Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
     305\end{adjustwidth}
     306
     307\paragraph{}
    252308\label{JAVA:JREGISTER-HANDLER}
    253309\index{JREGISTER-HANDLER}
    … …  
    255311
    256312\begin{adjustwidth}{5em}{5em}
    257 NOT-DOCUMENTED
     313not-documented
    258314\end{adjustwidth}
    259315
    … …  
    277333
    278334\paragraph{}
     335\label{JAVA:JARRAY-COMPONENT-TYPE}
     336\index{JARRAY-COMPONENT-TYPE}
     337--- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
     338
     339\begin{adjustwidth}{5em}{5em}
     340Returns the component type of the array type ATYPE
     341\end{adjustwidth}
     342
     343\paragraph{}
     344\label{JAVA:ADD-TO-CLASSPATH}
     345\index{ADD-TO-CLASSPATH}
     346--- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
     347
     348\begin{adjustwidth}{5em}{5em}
     349not-documented
     350\end{adjustwidth}
     351
     352\paragraph{}
    279353\label{JAVA:UNREGISTER-JAVA-EXCEPTION}
    280354\index{UNREGISTER-JAVA-EXCEPTION}
    … …  
    286360
    287361\paragraph{}
    288 \label{JAVA:JNEW}
    289 \index{JNEW}
    290 --- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
    291 
    292 \begin{adjustwidth}{5em}{5em}
    293 Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
    294 \end{adjustwidth}
    295 
    296 \paragraph{}
    297 \label{JAVA:JRUNTIME-CLASS-EXISTS-P}
    298 \index{JRUNTIME-CLASS-EXISTS-P}
    299 --- Function: \textbf{jruntime-class-exists-p} [\textbf{java}] \textit{}
    300 
    301 \begin{adjustwidth}{5em}{5em}
    302 NOT-DOCUMENTED
    303 \end{adjustwidth}
    304 
    305 \paragraph{}
    306 \label{JAVA:JARRAY-COMPONENT-TYPE}
    307 \index{JARRAY-COMPONENT-TYPE}
    308 --- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
    309 
    310 \begin{adjustwidth}{5em}{5em}
    311 Returns the component type of the array type ATYPE
    312 \end{adjustwidth}
    313 
    314 \paragraph{}
    315 \label{JAVA:ADD-TO-CLASSPATH}
    316 \index{ADD-TO-CLASSPATH}
    317 --- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
    318 
    319 \begin{adjustwidth}{5em}{5em}
    320 NOT-DOCUMENTED
    321 \end{adjustwidth}
    322 
    323 \paragraph{}
    324362\label{JAVA:JOBJECT-LISP-VALUE}
    325363\index{JOBJECT-LISP-VALUE}
    … …  
    336374
    337375\begin{adjustwidth}{5em}{5em}
    338 When called with one argument, returns the name of the Java class
    339   designated by CLASS-REF. When called with two arguments, tests
    340   whether CLASS-REF matches NAME.
     376not-documented
    341377\end{adjustwidth}
    342378
    … …  
    365401
    366402\begin{adjustwidth}{5em}{5em}
    367 NOT-DOCUMENTED
     403not-documented
    368404\end{adjustwidth}
    369405
    … …  
    374410
    375411\begin{adjustwidth}{5em}{5em}
    376 NOT-DOCUMENTED
     412not-documented
    377413\end{adjustwidth}
    378414
    … …  
    383419
    384420\begin{adjustwidth}{5em}{5em}
    385 NOT-DOCUMENTED
     421not-documented
    386422\end{adjustwidth}
    387423
    … …  
    448484
    449485\begin{adjustwidth}{5em}{5em}
    450 NOT-DOCUMENTED
     486not-documented
    451487\end{adjustwidth}
    452488
    … …  
    485521      derived from the instance.
    486522
     523
    487524\end{adjustwidth}
    488525
    … …  
    493530
    494531\begin{adjustwidth}{5em}{5em}
    495 NOT-DOCUMENTED
     532not-documented
    496533\end{adjustwidth}
    497534
    … …  
    520557
    521558\begin{adjustwidth}{5em}{5em}
    522 NOT-DOCUMENTED
     559not-documented
    523560\end{adjustwidth}
    524561
    … …  
    538575
    539576\begin{adjustwidth}{5em}{5em}
    540 NOT-DOCUMENTED
     577not-documented
    541578\end{adjustwidth}
    542579
    … …  
    587624
    588625\paragraph{}
    589 \label{JAVA:JREDEFINE-METHOD}
    590 \index{JREDEFINE-METHOD}
    591 --- Function: \textbf{jredefine-method} [\textbf{java}] \textit{}
    592 
    593 \begin{adjustwidth}{5em}{5em}
    594 NOT-DOCUMENTED
    595 \end{adjustwidth}
    596 
    597 \paragraph{}
    598626\label{JAVA:JCLASS-FIELDS}
    599627\index{JCLASS-FIELDS}
    … …  
    610638
    611639\begin{adjustwidth}{5em}{5em}
    612 NOT-DOCUMENTED
     640not-documented
    613641\end{adjustwidth}
    614642
    … …  
    619647
    620648\begin{adjustwidth}{5em}{5em}
    621 NOT-DOCUMENTED
     649not-documented
    622650\end{adjustwidth}
    623651
    … …  
    657685      derived from the instance.
    658686
     687
    659688\end{adjustwidth}
    660689
    … …  
    710739
    711740\begin{adjustwidth}{5em}{5em}
    712 NOT-DOCUMENTED
     741not-documented
    713742\end{adjustwidth}
    714743
    … …  
    737766
    738767\begin{adjustwidth}{5em}{5em}
    739 NOT-DOCUMENTED
     768not-documented
    740769\end{adjustwidth}
    741770
Note: See TracChangeset for help on using the changeset viewer.