Changeset 13613


Ignore:
Timestamp:
10/02/11 08:33:03 (10 years ago)
Author:
Mark Evenson
Message:

Differention symbols as to functions, generic functions, and macros.

Update scrape of docstrings

Location:
trunk/abcl/doc/manual
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/doc/manual/extensions.tex

    r13437 r13613  
    11\begin{verbatim}
    22%CADDR
    3   Function: (not documented)
     3  Macro: (not documented)
    44%CADR
    5   Function: (not documented)
     5  Macro: (not documented)
    66%CAR
    7   Function: (not documented)
     7  Macro: (not documented)
    88%CDR
    9   Function: (not documented)
     9  Macro: (not documented)
    1010*AUTOLOAD-VERBOSE*
    1111  Variable: (not documented)
     
    5555  Function: (not documented)
    5656AVER
    57   Function: (not documented)
     57  Macro: (not documented)
    5858CANCEL-FINALIZATION
    5959  Function: (not documented)
     
    6565  Function: (not documented)
    6666COLLECT
    67   Function: (not documented)
     67  Macro: (not documented)
    6868COMPILE-FILE-IF-NEEDED
    6969  Function: (not documented)
     
    145145  Class: (not documented)
    146146PATHNAME-JAR-P
    147   Function: Predicate for whether PATHNAME references a JAR.
     147  Function: (not documented)
    148148PATHNAME-URL-P
    149149  Function: Predicate for whether PATHNAME references a URL.
     
    227227  Function: (not documented)
    228228TRULY-THE
    229   Function: (not documented)
     229  Special Operator: (not documented)
    230230UPTIME
    231231  Function: (not documented)
  • trunk/abcl/doc/manual/java.tex

    r13438 r13613  
    11\begin{verbatim}
    2 
    32%JGET-PROPERTY-VALUE
    43  Function: Gets a JavaBeans property on JAVA-OBJECT.
    5 
    64%JSET-PROPERTY-VALUE
    75  Function: Sets a JavaBean property on JAVA-OBJECT.
    8 
    9 *JAVA-OBJECT-TO-STRING-LENGTH*
    10  Variable: Length to truncate toString()
    11  PRINT-OBJECT output for an otherwise unspecialized JAVA-OBJECT.  Can
    12  be set to NIL to indicate no limit.
    13 
     6*JAVA-OBJECT-TO-STRING-LENGTH*
     7  Variable: Length to truncate toString() PRINT-OBJECT output for an otherwise unspecialized JAVA-OBJECT.  Can be set to NIL to indicate no limit.
     8+FALSE+
     9  Variable: (not documented)
     10+NULL+
     11  Variable: (not documented)
     12+TRUE+
     13  Variable: (not documented)
    1414ADD-TO-CLASSPATH
    15   Function: (not documented)
    16 
     15  Generic Function: (not documented)
    1716CHAIN
    18   Function: (not documented)
    19 
     17  Macro: (not documented)
    2018DESCRIBE-JAVA-OBJECT
    2119  Function: (not documented)
    22 
    2320DUMP-CLASSPATH
    2421  Function: (not documented)
    25 
    2622ENSURE-JAVA-CLASS
    2723  Function: (not documented)
    28 
    2924ENSURE-JAVA-OBJECT
    3025  Function: Ensures OBJ is wrapped in a JAVA-OBJECT, wrapping it if necessary.
    31 
     26GET-CURRENT-CLASSLOADER
     27  Function: (not documented)
    3228GET-DEFAULT-CLASSLOADER
    3329  Function: (not documented)
    34 
    3530JARRAY-COMPONENT-TYPE
    3631  Function: Returns the component type of the array type ATYPE
    37 
    3832JARRAY-LENGTH
    3933  Function: (not documented)
    40 
    4134JARRAY-REF
    42  Function: Dereferences the Java array JAVA-ARRAY using the given
    43  INDICIES, coercing the result into a Lisp object, if possible.
    44 
     35  Function: Dereferences the Java array JAVA-ARRAY using the given INDICIES, coercing the result into a Lisp object, if possible.
    4536JARRAY-REF-RAW
    46  Function: Dereference the Java array JAVA-ARRAY using the given
    47  INDICIES. Does not attempt to coerce the result into a Lisp object.
    48 
     37  Function: Dereference the Java array JAVA-ARRAY using the given INDICIES. Does not attempt to coerce the result into a Lisp object.
    4938JARRAY-SET
    5039  Function: Stores NEW-VALUE at the given index in JAVA-ARRAY.
    51 
    5240JAVA-CLASS
    5341  Class: (not documented)
    54 
    5542JAVA-EXCEPTION
    5643  Class: (not documented)
    57 
    5844JAVA-EXCEPTION-CAUSE
    59   Function: Returns the cause of JAVA-EXCEPTION. (The cause is the Java Throwable
    60 
     45  Function: (not documented)
    6146JAVA-OBJECT
    6247  Class: (not documented)
    63 
    6448JAVA-OBJECT-P
    6549  Function: Returns T if OBJECT is a JAVA-OBJECT.
    66 
    6750JCALL
    68  Function: Invokes the Java method METHOD-REF on INSTANCE with
    69  arguments ARGS, coercing the result into a Lisp object, if possible.
    70 
     51  Function: Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS, coercing the result into a Lisp object, if possible.
    7152JCALL-RAW
    72  Function: Invokes the Java method METHOD-REF on INSTANCE with
    73  arguments ARGS. Does not attempt to coerce the result into a Lisp
    74  object.
    75 
     53  Function: Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS. Does not attempt to coerce the result into a Lisp object.
    7654JCLASS
    77  Function: Returns a reference to the Java class designated by
    78  NAME-OR-CLASS-REF. If the CLASS-LOADER parameter is passed, the class
    79  is resolved with respect to the given ClassLoader.
    80 
     55  Function: Returns a reference to the Java class designated by NAME-OR-CLASS-REF. If the CLASS-LOADER parameter is passed, the class is resolved with respect to the given ClassLoader.
    8156JCLASS-ARRAY-P
    8257  Function: Returns T if CLASS is an array class
    83 
    8458JCLASS-CONSTRUCTORS
    8559  Function: Returns a vector of constructors for CLASS
    86 
    8760JCLASS-FIELD
    8861  Function: Returns the field named FIELD-NAME of CLASS
    89 
    9062JCLASS-FIELDS
    91   Function: Returns a vector of all (or just the declared/public, if
    92   DECLARED/PUBLIC is true) fields of CLASS
    93 
     63  Function: Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS
    9464JCLASS-INTERFACE-P
    9565  Function: Returns T if CLASS is an interface
    96 
    9766JCLASS-INTERFACES
    9867  Function: Returns the vector of interfaces of CLASS
    99 
    10068JCLASS-METHODS
    101   Function: Return a vector of all (or just the declared/public, if
    102  DECLARED/PUBLIC is true) methods of CLASS
    103 
     69  Function: Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS
    10470JCLASS-NAME
    105   Function: When called with one argument, returns the name of the Java class
    106 
     71  Function: (not documented)
    10772JCLASS-OF
    10873  Function: (not documented)
    109 
    11074JCLASS-SUPERCLASS
    11175  Function: Returns the superclass of CLASS, or NIL if it hasn't got one
    112 
    11376JCLASS-SUPERCLASS-P
    11477  Function: Returns T if CLASS-1 is a superclass or interface of CLASS-2
    115 
    11678JCOERCE
    117   Function: Attempts to coerce OBJECT into a JavaObject of class
    118  INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
    119 
     79  Function: Attempts to coerce OBJECT into a JavaObject of class INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
    12080JCONSTRUCTOR
    121   Function: Returns a reference to the Java constructor of CLASS-REF
    122   with the given PARAMETER-CLASS-REFS.
    123 
     81  Function: Returns a reference to the Java constructor of CLASS-REF with the given PARAMETER-CLASS-REFS.
    12482JCONSTRUCTOR-PARAMS
    12583  Function: Returns a vector of parameter types (Java classes) for CONSTRUCTOR
    126 
    12784JEQUAL
    12885  Function: Compares obj1 with obj2 using java.lang.Object.equals()
    129 
    13086JFIELD
    13187  Function: Retrieves or modifies a field in a Java class or instance.
    132 
    13388JFIELD-NAME
    13489  Function: Returns the name of FIELD as a Lisp string
    135 
    13690JFIELD-RAW
    13791  Function: Retrieves or modifies a field in a Java class or instance. Does not
    138 
    13992JFIELD-TYPE
    14093  Function: Returns the type (Java class) of FIELD
    141 
    14294JINSTANCE-OF-P
    14395  Function: OBJ is an instance of CLASS (or one of its subclasses)
    144 
    14596JINTERFACE-IMPLEMENTATION
    14697  Function: Creates and returns an implementation of a Java interface with
    147 
    14898JMAKE-INVOCATION-HANDLER
    14999  Function: (not documented)
    150 
    151100JMAKE-PROXY
    152   Function: (not documented)
    153 
     101  Generic Function: (not documented)
    154102JMEMBER-PROTECTED-P
    155103  Function: MEMBER is a protected member of its declaring class
    156 
    157104JMEMBER-PUBLIC-P
    158105  Function: MEMBER is a public member of its declaring class
    159 
    160106JMEMBER-STATIC-P
    161107  Function: MEMBER is a static member of its declaring class
    162 
    163108JMETHOD
    164   Function: Returns a reference to the Java method METHOD-NAME of
    165   CLASS-REF with the given PARAMETER-CLASS-REFS.
    166 
     109  Function: Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.
    167110JMETHOD-LET
    168   Function: (not documented)
    169 
     111  Macro: (not documented)
    170112JMETHOD-NAME
    171113  Function: Returns the name of METHOD as a Lisp string
    172 
    173114JMETHOD-PARAMS
    174115  Function: Returns a vector of parameter types (Java classes) for METHOD
    175 
    176116JMETHOD-RETURN-TYPE
    177117  Function: Returns the result type (Java class) of the METHOD
    178 
    179118JNEW
    180119  Function: Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
    181 
    182120JNEW-ARRAY
    183121  Function: Creates a new Java array of type ELEMENT-TYPE, with the given DIMENSIONS.
    184 
    185122JNEW-ARRAY-FROM-ARRAY
    186123  Function: Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
    187 
    188124JNEW-ARRAY-FROM-LIST
    189125  Function: (not documented)
    190 
    191126JNEW-RUNTIME-CLASS
    192127  Function: (not documented)
    193 
    194128JNULL-REF-P
    195129  Function: Returns a non-NIL value when the JAVA-OBJECT `object` is `null`,
    196 
    197130JOBJECT-CLASS
    198131  Function: Returns the Java class that OBJ belongs to
    199 
    200132JOBJECT-LISP-VALUE
    201133  Function: Attempts to coerce JAVA-OBJECT into a Lisp object.
    202 
    203134JPROPERTY-VALUE
    204135  Function: (not documented)
    205 
    206136JREDEFINE-METHOD
    207137  Function: (not documented)
    208 
    209138JREGISTER-HANDLER
    210139  Function: (not documented)
    211 
    212140JRESOLVE-METHOD
    213   Function: Finds the most specific Java method METHOD-NAME on
    214   INSTANCE applicable to arguments ARGS. Returns NIL if no suitable
    215   method is found. The algorithm used for resolution is the same used
    216   by JCALL when it is called with a string as the first parameter
    217  (METHOD-REF).
    218 
     141  Function: Finds the most specific Java method METHOD-NAME on INSTANCE applicable to arguments ARGS. Returns NIL if no suitable method is found. The algorithm used for resolution is the same used by JCALL when it is called with a string as the first parameter (METHOD-REF).
    219142JRUN-EXCEPTION-PROTECTED
    220   Function: Invokes the function CLOSURE and returns the result.
    221   Signals an error if stack or heap exhaustion occurs.
    222 
     143  Function: Invokes the function CLOSURE and returns the result.  Signals an error if stack or heap exhaustion occurs.
    223144JRUNTIME-CLASS-EXISTS-P
    224145  Function: (not documented)
    225 
    226146JSTATIC
    227147  Function: Invokes the static method METHOD on class CLASS with ARGS.
    228 
    229148JSTATIC-RAW
    230   Function: Invokes the static method METHOD on class CLASS with
    231   ARGS. Does not attempt to coerce the arguments or result into a Lisp
    232   object.
    233 
     149  Function: Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
    234150MAKE-CLASSLOADER
    235151  Function: (not documented)
    236 
    237152MAKE-IMMEDIATE-OBJECT
    238153  Function: Attempts to coerce a given Lisp object into a java-object of the
    239 
    240154REGISTER-JAVA-EXCEPTION
    241   Function: Registers the Java Throwable named by the symbol
    242   EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL.
    243   Returns T if successful, NIL if not.
    244 
     155  Function: Registers the Java Throwable named by the symbol EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL.  Returns T if successful, NIL if not.
    245156UNREGISTER-JAVA-EXCEPTION
    246157  Function: Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION.
Note: See TracChangeset for help on using the changeset viewer.