doc: further transcriptions of exported symbols

parent 9cafdbfd
\paragraph{}
\label{ABCL-ASDF:*ADDED-TO-CLASSPATH*}
\index{*ADDED-TO-CLASSPATH*}
--- Variable: \textbf{*added-to-classpath*} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:*INHIBIT-ADD-TO-CLASSPATH*}
\index{*INHIBIT-ADD-TO-CLASSPATH*}
--- Variable: \textbf{*inhibit-add-to-classpath*} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:*MAVEN-HTTP-PROXY*}
\index{*MAVEN-HTTP-PROXY*}
--- Variable: \textbf{*maven-http-proxy*} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
A string containing the URI of an http proxy for Maven to use.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:*MAVEN-REMOTE-REPOSITORY*}
\index{*MAVEN-REMOTE-REPOSITORY*}
--- Variable: \textbf{*maven-remote-repository*} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
The remote repository used by the Maven Aether embedder.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:*MAVEN-VERBOSE*}
\index{*MAVEN-VERBOSE*}
--- Variable: \textbf{*maven-verbose*} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
Stream to send output from the Maven Aether subsystem to, or NIL to muffle output
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:*MVN-LIBS-DIRECTORY*}
\index{*MVN-LIBS-DIRECTORY*}
--- Variable: \textbf{*mvn-libs-directory*} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
Location of 'maven-core-3.<m>.<p>.jar', 'maven-embedder-3.<m>.<p>.jar' etc.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:ADD-DIRECTORY-JARS-TO-CLASS-PATH}
\index{ADD-DIRECTORY-JARS-TO-CLASS-PATH}
--- Function: \textbf{add-directory-jars-to-class-path} [\textbf{abcl-asdf}] \textit{directory recursive-p}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:AS-CLASSPATH}
\index{AS-CLASSPATH}
--- Function: \textbf{as-classpath} [\textbf{abcl-asdf}] \textit{classpath}
\begin{adjustwidth}{5em}{5em}
Break apart the JVM CLASSPATH string into a list of its consituents.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:ENSURE-MVN-VERSION}
\index{ENSURE-MVN-VERSION}
--- Function: \textbf{ensure-mvn-version} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
Return t if Maven version is 3.0.3 or greater.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:FIND-MVN}
\index{FIND-MVN}
--- Function: \textbf{find-mvn} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
Attempt to find a suitable Maven ('mvn') executable on the hosting operating system.
Returns the path of the Maven executable or nil if none are found.
Returns the version of Maven found as the second value.
Emits warnings if not able to find a suitable executable.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:INIT}
\index{INIT}
--- Function: \textbf{init} [\textbf{abcl-asdf}] \textit{\&optional \&key (force NIL)}
\begin{adjustwidth}{5em}{5em}
Run the initialization strategy to bootstrap a Maven dependency node.
Set *MVN-LIBS-DIRECTORY* to an explicit value before running this
function in order to bypass the dynamic introspection of the location
of the mvn executable with an explicit value.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:MAKE-REMOTE-REPOSITORY}
\index{MAKE-REMOTE-REPOSITORY}
--- Function: \textbf{make-remote-repository} [\textbf{abcl-asdf}] \textit{id type url}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:NEED-TO-ADD-DIRECTORY-JAR?}
\index{NEED-TO-ADD-DIRECTORY-JAR?}
--- Function: \textbf{need-to-add-directory-jar?} [\textbf{abcl-asdf}] \textit{directory recursive-p}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:RESOLVE}
\index{RESOLVE}
--- Generic Function: \textbf{resolve} [\textbf{abcl-asdf}] \textit{}
\begin{adjustwidth}{5em}{5em}
Returns a string in JVM CLASSPATH format as entries delimited by classpath separator string.
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:RESOLVE-ARTIFACT}
\index{RESOLVE-ARTIFACT}
--- Function: \textbf{resolve-artifact} [\textbf{abcl-asdf}] \textit{group-id artifact-id \&key (version LATEST versionp)}
\begin{adjustwidth}{5em}{5em}
Resolve artifact to location on the local filesystem.
Declared dependencies are not attempted to be located.
If unspecified, the string "LATEST" will be used for the VERSION.
Returns the Maven specific string for the artifact
\end{adjustwidth}
\paragraph{}
\label{ABCL-ASDF:RESOLVE-DEPENDENCIES}
\index{RESOLVE-DEPENDENCIES}
--- Function: \textbf{resolve-dependencies} [\textbf{abcl-asdf}] \textit{group-id artifact-id \&key (version LATEST versionp) (repository *maven-remote-repository* repository-p)}
\begin{adjustwidth}{5em}{5em}
Dynamically resolve Maven dependencies for item with GROUP-ID and ARTIFACT-ID
optionally with a VERSION and a REPOSITORY.
All recursive dependencies will be visited before resolution is successful.
If unspecified, the string "LATEST" will be used for the VERSION.
Returns a string containing the necessary jvm classpath entries packed
in Java CLASSPATH representation.
\end{adjustwidth}
......@@ -106,6 +106,15 @@ not-documented
not-documented
\end{adjustwidth}
\paragraph{}
\label{EXTENSIONS:*GUI-BACKEND*}
\index{*GUI-BACKEND*}
--- Variable: \textbf{*gui-backend*} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{EXTENSIONS:*INSPECTOR-HOOK*}
\index{*INSPECTOR-HOOK*}
......@@ -492,7 +501,7 @@ Returns all environment variables as an alist containing (name . value)
--- Function: \textbf{init-gui} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
Dummy function used to autoload this file
\end{adjustwidth}
\paragraph{}
......@@ -600,7 +609,7 @@ Create and return the pathname of a previously non-existent file.
--- Function: \textbf{make-weak-reference} [\textbf{extensions}] \textit{obj}
\begin{adjustwidth}{5em}{5em}
not-documented
Creates a weak reference to 'obj'.
\end{adjustwidth}
\paragraph{}
......@@ -781,7 +790,7 @@ Returns either the function or NIL if no resolution was possible.
--- Function: \textbf{run-shell-command} [\textbf{extensions}] \textit{command \&key directory (output *standard-output*)}
\begin{adjustwidth}{5em}{5em}
not-documented
Deprecated. Use SYS:RUN-PROGRAM.
\end{adjustwidth}
\paragraph{}
......
......@@ -343,7 +343,9 @@ When called with one argument, returns the name of the Java class
--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
\begin{adjustwidth}{5em}{5em}
not-documented
Returns the name of the Java class of OBJECT. If the NAME argument is
supplied, verifies that OBJECT is an instance of the named class. The name
of the class or nil is always returned as a second value.
\end{adjustwidth}
\paragraph{}
......
......@@ -1349,7 +1349,8 @@ not-documented
--- Function: \textbf{find-contrib} [\textbf{system}] \textit{}
\begin{adjustwidth}{5em}{5em}
Introspect runtime classpaths to find a loadable ABCL-CONTRIB.
Introspect runtime classpaths to return a pathname containing
subdirectories containing ASDF definitions.
\end{adjustwidth}
\paragraph{}
......@@ -1358,7 +1359,7 @@ Introspect runtime classpaths to find a loadable ABCL-CONTRIB.
--- Function: \textbf{find-system} [\textbf{system}] \textit{}
\begin{adjustwidth}{5em}{5em}
Find the location of the system.
Find the location of the Armed Bear system implementation
Used to determine relative pathname to find 'abcl-contrib.jar'.
\end{adjustwidth}
......@@ -2020,13 +2021,22 @@ not-documented
not-documented
\end{adjustwidth}
\paragraph{}
\label{SYSTEM:PROCESS}
\index{PROCESS}
--- Class: \textbf{process} [\textbf{system}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
\label{SYSTEM:PROCESS-ALIVE-P}
\index{PROCESS-ALIVE-P}
--- Function: \textbf{process-alive-p} [\textbf{system}] \textit{process}
\begin{adjustwidth}{5em}{5em}
not-documented
Return t if process is still alive, nil otherwise.
\end{adjustwidth}
\paragraph{}
......@@ -2182,6 +2192,38 @@ not-documented
not-documented
\end{adjustwidth}
\paragraph{}
\label{SYSTEM:RECORD-SOURCE-INFORMATION-FOR-TYPE}
\index{RECORD-SOURCE-INFORMATION-FOR-TYPE}
--- Function: \textbf{record-source-information-for-type} [\textbf{system}] \textit{name type \&optional source-pathname source-position}
\begin{adjustwidth}{5em}{5em}
Record source information on the SYS:SOURCE property for symbol with NAME
TYPE is either a symbol or list.
Source information for functions, methods, and generic functions are
represented as lists of the following form:
(:generic-function function-name)
(:function function-name)
(:method method-name qualifiers specializers)
Where FUNCTION-NAME or METHOD-NAME can be a either be of the form
'symbol or '(setf symbol).
Source information for all other forms have a symbol for TYPE which is
one of the following:
:class, :variable, :condition, :constant, :compiler-macro, :macro
:package, :structure, :type, :setf-expander, :source-transform
These values follow SBCL'S implemenation in SLIME
c.f. <https://github.com/slime/slime/blob/bad2acf672c33b913aabc1a7facb9c3c16a4afe9/swank/sbcl.lisp\#L748>
\end{adjustwidth}
\paragraph{}
\label{SYSTEM:REMEMBER}
\index{REMEMBER}
......@@ -2387,7 +2429,7 @@ not-documented
--- Function: \textbf{sha256} [\textbf{system}] \textit{\&rest paths-or-strings}
\begin{adjustwidth}{5em}{5em}
not-documented
Returned ASCIIfied representation of SHA256 digest of byte-based resource at PATHS-OR-STRINGs.
\end{adjustwidth}
\paragraph{}
......@@ -2603,7 +2645,8 @@ not-documented
--- Function: \textbf{unzip} [\textbf{system}] \textit{pathname \&optional directory => unzipped\_pathnames}
\begin{adjustwidth}{5em}{5em}
not-documented
Unpack zip archive at PATHNAME returning a list of extracted pathnames.
If the optional DIRECTORY is specified, root the abstraction in that directory, otherwise use the current value of *DEFAULT-PATHNAME-DEFAULTS*.
\end{adjustwidth}
\paragraph{}
......
......@@ -81,7 +81,7 @@ to wake up for retrieval of that object.
\paragraph{}
\label{THREADS:MAKE-MAILBOX}
\index{MAKE-MAILBOX}
--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g282154) NIL)}
--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g283945) NIL)}
\begin{adjustwidth}{5em}{5em}
not-documented
......@@ -90,7 +90,7 @@ not-documented
\paragraph{}
\label{THREADS:MAKE-MUTEX}
\index{MAKE-MUTEX}
--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g282414) NIL)}
--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g284205) NIL)}
\begin{adjustwidth}{5em}{5em}
not-documented
......@@ -227,7 +227,8 @@ not-documented
--- Macro: \textbf{with-mutex} [\textbf{threads}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
Acquires a lock on `mutex', executes the body
and releases the lock.
\end{adjustwidth}
\paragraph{}
......@@ -236,7 +237,7 @@ not-documented
--- Macro: \textbf{with-thread-lock} [\textbf{threads}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
Acquires a lock on the `lock', executes `body' and releases the lock.
\end{adjustwidth}
\paragraph{}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment