Changeset 14932


Ignore:
Timestamp:
12/27/16 20:23:05 (5 years ago)
Author:
Mark Evenson
Message:

doc: further transcriptions of exported symbols

Location:
trunk/abcl/doc/manual
Files:
1 added
4 edited

Legend:

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

    r14931 r14932  
    102102\index{*ENABLE-INLINE-EXPANSION*}
    103103--- Variable: \textbf{*enable-inline-expansion*} [\textbf{extensions}] \textit{}
     104
     105\begin{adjustwidth}{5em}{5em}
     106not-documented
     107\end{adjustwidth}
     108
     109\paragraph{}
     110\label{EXTENSIONS:*GUI-BACKEND*}
     111\index{*GUI-BACKEND*}
     112--- Variable: \textbf{*gui-backend*} [\textbf{extensions}] \textit{}
    104113
    105114\begin{adjustwidth}{5em}{5em}
     
    493502
    494503\begin{adjustwidth}{5em}{5em}
    495 not-documented
     504Dummy function used to autoload this file
    496505\end{adjustwidth}
    497506
     
    601610
    602611\begin{adjustwidth}{5em}{5em}
    603 not-documented
     612Creates a weak reference to 'obj'.
    604613\end{adjustwidth}
    605614
     
    782791
    783792\begin{adjustwidth}{5em}{5em}
    784 not-documented
     793Deprecated.  Use SYS:RUN-PROGRAM.
    785794\end{adjustwidth}
    786795
  • trunk/abcl/doc/manual/java.tex

    r14931 r14932  
    344344
    345345\begin{adjustwidth}{5em}{5em}
    346 not-documented
     346Returns the name of the Java class of OBJECT. If the NAME argument is
     347  supplied, verifies that OBJECT is an instance of the named class. The name
     348  of the class or nil is always returned as a second value.
    347349\end{adjustwidth}
    348350
  • trunk/abcl/doc/manual/system.tex

    r14892 r14932  
    13501350
    13511351\begin{adjustwidth}{5em}{5em}
    1352 Introspect runtime classpaths to find a loadable ABCL-CONTRIB.
     1352Introspect runtime classpaths to return a pathname containing
     1353  subdirectories containing ASDF definitions.
    13531354\end{adjustwidth}
    13541355
     
    13591360
    13601361\begin{adjustwidth}{5em}{5em}
    1361 Find the location of the system.
     1362Find the location of the Armed Bear system implementation
    13621363
    13631364Used to determine relative pathname to find 'abcl-contrib.jar'.
     
    20222023
    20232024\paragraph{}
     2025\label{SYSTEM:PROCESS}
     2026\index{PROCESS}
     2027--- Class: \textbf{process} [\textbf{system}] \textit{}
     2028
     2029\begin{adjustwidth}{5em}{5em}
     2030not-documented
     2031\end{adjustwidth}
     2032
     2033\paragraph{}
    20242034\label{SYSTEM:PROCESS-ALIVE-P}
    20252035\index{PROCESS-ALIVE-P}
     
    20272037
    20282038\begin{adjustwidth}{5em}{5em}
    2029 not-documented
     2039Return t if process is still alive, nil otherwise.
    20302040\end{adjustwidth}
    20312041
     
    21812191\begin{adjustwidth}{5em}{5em}
    21822192not-documented
     2193\end{adjustwidth}
     2194
     2195\paragraph{}
     2196\label{SYSTEM:RECORD-SOURCE-INFORMATION-FOR-TYPE}
     2197\index{RECORD-SOURCE-INFORMATION-FOR-TYPE}
     2198--- Function: \textbf{record-source-information-for-type} [\textbf{system}] \textit{name type \&optional source-pathname source-position}
     2199
     2200\begin{adjustwidth}{5em}{5em}
     2201Record source information on the SYS:SOURCE property for symbol with NAME
     2202
     2203TYPE is either a symbol or list.
     2204
     2205Source information for functions, methods, and generic functions are
     2206represented as lists of the following form:
     2207
     2208    (:generic-function function-name)
     2209    (:function function-name)
     2210    (:method method-name qualifiers specializers)
     2211
     2212Where FUNCTION-NAME or METHOD-NAME can be a either be of the form
     2213'symbol or '(setf symbol).
     2214
     2215Source information for all other forms have a symbol for TYPE which is
     2216one of the following:
     2217
     2218:class, :variable, :condition, :constant, :compiler-macro, :macro
     2219:package, :structure, :type, :setf-expander, :source-transform
     2220
     2221These values follow SBCL'S implemenation in SLIME
     2222c.f. <https://github.com/slime/slime/blob/bad2acf672c33b913aabc1a7facb9c3c16a4afe9/swank/sbcl.lisp\#L748>
     2223
     2224
    21832225\end{adjustwidth}
    21842226
     
    23882430
    23892431\begin{adjustwidth}{5em}{5em}
    2390 not-documented
     2432Returned ASCIIfied representation of SHA256 digest of byte-based resource at PATHS-OR-STRINGs.
    23912433\end{adjustwidth}
    23922434
     
    26042646
    26052647\begin{adjustwidth}{5em}{5em}
    2606 not-documented
     2648Unpack zip archive at PATHNAME returning a list of extracted pathnames.
     2649If the optional DIRECTORY is specified, root the abstraction in that directory, otherwise use the current value of *DEFAULT-PATHNAME-DEFAULTS*.
    26072650\end{adjustwidth}
    26082651
  • trunk/abcl/doc/manual/threads.tex

    r14892 r14932  
    8282\label{THREADS:MAKE-MAILBOX}
    8383\index{MAKE-MAILBOX}
    84 --- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g282154) NIL)}
     84--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g283945) NIL)}
    8585
    8686\begin{adjustwidth}{5em}{5em}
     
    9191\label{THREADS:MAKE-MUTEX}
    9292\index{MAKE-MUTEX}
    93 --- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g282414) NIL)}
     93--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g284205) NIL)}
    9494
    9595\begin{adjustwidth}{5em}{5em}
     
    228228
    229229\begin{adjustwidth}{5em}{5em}
    230 not-documented
     230Acquires a lock on `mutex', executes the body
     231and releases the lock.
    231232\end{adjustwidth}
    232233
     
    237238
    238239\begin{adjustwidth}{5em}{5em}
    239 not-documented
     240Acquires a lock on the `lock', executes `body' and releases the lock.
    240241\end{adjustwidth}
    241242
Note: See TracChangeset for help on using the changeset viewer.