This is the 40ants-doc Reference Manual, version 0.12.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 05:03:37 2024 GMT+0.
40ants-doc
40ants-doc/core
40ants-doc/reference
40ants-doc/reference-api
40ants-doc/source-api
40ants-doc/locatives
40ants-doc/locatives/base
40ants-doc/object-package
40ants-doc/docstring
40ants-doc/restart
40ants-doc/locatives/define-definer
40ants-doc/glossary
40ants-doc/changelog
40ants-doc/ignored-words
40ants-doc/40ants-doc.asd
40ants-doc/core/file-type.lisp
40ants-doc/reference/file-type.lisp
40ants-doc/reference-api/file-type.lisp
40ants-doc/source-api/file-type.lisp
40ants-doc/locatives/file-type.lisp
40ants-doc/locatives/base/file-type.lisp
40ants-doc/object-package/file-type.lisp
40ants-doc/docstring/file-type.lisp
40ants-doc/restart/file-type.lisp
40ants-doc/locatives/define-definer/file-type.lisp
40ants-doc/glossary/file-type.lisp
40ants-doc/changelog/file-type.lisp
40ants-doc/ignored-words/file-type.lisp
40ants-doc/locatives/base
40ants-doc/source-api
40ants-doc/object-package
40ants-doc
40ants-doc/locatives/define-definer
40ants-doc/locatives
40ants-doc/glossary
40ants-doc/docstring
40ants-doc/ignored-words
40ants-doc/reference
40ants-doc/restart
40ants-doc/changelog
40ants-doc/reference-api
The main system appears first, followed by any subsystem dependency.
40ants-doc
40ants-doc/core
40ants-doc/reference
40ants-doc/reference-api
40ants-doc/source-api
40ants-doc/locatives
40ants-doc/locatives/base
40ants-doc/object-package
40ants-doc/docstring
40ants-doc/restart
40ants-doc/locatives/define-definer
40ants-doc/glossary
40ants-doc/changelog
40ants-doc/ignored-words
40ants-doc
Allows to put documentation inside lisp files and cross-reference between different entities. Based on MGL-PAX.
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
0.12.0
uiop
(system).
40ants-doc/core
(system).
40ants-doc/restart
(system).
40ants-doc/glossary
(system).
40ants-doc/changelog
(system).
40ants-doc/ignored-words
(system).
40ants-doc/core
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/reference
(system).
40ants-doc/locatives/base
(system).
40ants-doc/object-package
(system).
40ants-doc/docstring
(system).
40ants-doc/reference
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/reference-api
(system).
40ants-doc/source-api
(system).
40ants-doc/locatives
(system).
40ants-doc/locatives/base
(system).
40ants-doc/object-package
(system).
40ants-doc/reference-api
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/source-api
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
named-readtables
(system).
pythonic-string-reader
(system).
40ants-doc/locatives
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
asdf
(system).
40ants-doc/locatives/base
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/source-api
(system).
named-readtables
(system).
pythonic-string-reader
(system).
40ants-doc/object-package
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/docstring
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/restart
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/locatives/define-definer
(system).
named-readtables
(system).
pythonic-string-reader
(system).
40ants-doc/locatives/define-definer
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/locatives/base
(system).
40ants-doc/glossary
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/core
(system).
40ants-doc/changelog
Alexander Artemenko
(GIT https://github.com/40ants/doc)
MIT
40ants-doc/core
(system).
pythonic-string-reader
(system).
named-readtables
(system).
Files are sorted by type and then listed depth-first from the systems components trees.
40ants-doc/40ants-doc.asd
40ants-doc/core/file-type.lisp
40ants-doc/reference/file-type.lisp
40ants-doc/reference-api/file-type.lisp
40ants-doc/source-api/file-type.lisp
40ants-doc/locatives/file-type.lisp
40ants-doc/locatives/base/file-type.lisp
40ants-doc/object-package/file-type.lisp
40ants-doc/docstring/file-type.lisp
40ants-doc/restart/file-type.lisp
40ants-doc/locatives/define-definer/file-type.lisp
40ants-doc/glossary/file-type.lisp
40ants-doc/changelog/file-type.lisp
40ants-doc/ignored-words/file-type.lisp
40ants-doc/40ants-doc.asd
40ants-doc
(system).
40ants-doc
.
40ants-doc/core
.
40ants-doc/reference
.
40ants-doc/reference-api
.
40ants-doc/source-api
.
40ants-doc/locatives
.
40ants-doc/locatives/base
.
40ants-doc/object-package
.
40ants-doc/docstring
.
40ants-doc/restart
.
40ants-doc/locatives/define-definer
.
40ants-doc/glossary
.
40ants-doc/changelog
.
40ants-doc/ignored-words
.
40ants-doc/core/file-type.lisp
40ants-doc/core
(system).
*discard-documentation-p*
(special variable).
*symbols-with-ignored-missing-locations*
(special variable).
defsection
(macro).
defsection-copy
(macro).
exportable-locative-type-p
(generic function).
print-object
(method).
section
(class).
section-entries
(reader method).
section-external-docs
(reader method).
section-ignore-words
(reader method).
section-link-title-to
(reader method).
section-name
(reader method).
section-package
(reader method).
section-readtable
(reader method).
section-title
(reader method).
ensure-list
(function).
ensure-package
(function).
entry-to-reference
(function).
export-some-symbols
(function).
locative-equal
(function).
object-package
(method).
symbol-accessible-in-package-p
(function).
transform-entries
(function).
transform-link-title-to
(function).
transform-locative-symbols
(function).
40ants-doc/reference/file-type.lisp
40ants-doc/reference
(system).
canonical-reference
(method).
find-source
(method).
make-reference
(function).
print-object
(method).
reference
(class).
reference-locative
(reader method).
reference-object
(reader method).
resolve
(function).
*reference-being-documented*
(special variable).
*references*
(special variable).
external-reference
(class).
external-reference-p
(function).
external-reference-url
(reader method).
make-external-reference
(function).
object-package
(method).
reference-locative-type
(function).
reference-to-anchor
(function).
reference=
(function).
references-for-symbol
(function).
references-for-the-same-symbol-p
(function).
resolve-dislocated
(function).
resolve-generic-function-and-methods
(function).
40ants-doc/reference-api/file-type.lisp
40ants-doc/reference-api
(system).
*source-uri-fn*
(special variable).
canonical-reference
(generic function).
source-uri
(function).
reference-name
(generic function).
40ants-doc/source-api/file-type.lisp
40ants-doc/source-api
(system).
find-source
(generic function).
40ants-doc/locatives/file-type.lisp
40ants-doc/locatives
(system).
40ants-doc/locatives/base/file-type.lisp
40ants-doc/locatives/base
(system).
define-locative-type
(macro).
locate
(function).
locate-and-find-source
(generic function).
locate-error
(function).
locate-error
(condition).
locate-error-locative
(reader method).
locate-error-message
(reader method).
locate-error-object
(reader method).
locate-object
(generic function).
locative-args
(generic function).
locative-equal
(function).
locative-type
(generic function).
locative-lambda-list
(generic function).
symbol-lambda-list
(generic function).
symbol-lambda-list-method
(function).
40ants-doc/object-package/file-type.lisp
40ants-doc/object-package
(system).
object-package
(generic function).
40ants-doc/docstring/file-type.lisp
40ants-doc/docstring
(system).
get-docstring
(function).
strip-docstring-indentation
(function).
*whitespace-chars*
(special variable).
blankp
(function).
docstring-indentation
(function).
filter-documentation
(function).
n-leading-spaces
(function).
trim-whitespace
(function).
whitespacep
(function).
40ants-doc/restart/file-type.lisp
40ants-doc/restart
(system).
define-restart
(macro).
40ants-doc/locatives/define-definer/file-type.lisp
40ants-doc/locatives/define-definer
(system).
expand-define-definer-for-symbol-as-locative-definer-body
(function).
40ants-doc/glossary/file-type.lisp
40ants-doc/glossary
(system).
define-glossary-term
(macro).
print-object
(method).
glossary-term
(class).
glossary-term-docstring
(reader method).
glossary-term-name
(reader method).
glossary-term-title
(reader method).
40ants-doc/changelog/file-type.lisp
40ants-doc/changelog
(system).
@changelog
(special variable).
defchangelog
(macro).
0.1.0
(special variable).
0.10.0
(special variable).
0.11.0
(special variable).
0.11.1
(special variable).
0.11.2
(special variable).
0.12.0
(special variable).
0.13.0
(special variable).
0.14.0
(special variable).
0.15.0
(special variable).
0.15.1
(special variable).
0.2.0
(special variable).
0.3.0
(special variable).
0.4.0
(special variable).
0.4.1
(special variable).
0.5.0
(special variable).
0.5.1
(special variable).
0.5.2
(special variable).
0.5.3
(special variable).
0.5.4
(special variable).
0.5.5
(special variable).
0.5.6
(special variable).
0.5.7
(special variable).
0.5.8
(special variable).
0.6.0
(special variable).
0.7.0
(special variable).
0.8.0
(special variable).
0.9.0
(special variable).
0.9.1
(special variable).
0.9.2
(special variable).
@index
(special variable).
changelog
(class).
looks-like-date
(function).
make-version-section
(function).
split-date-if-given
(function).
version
(class).
version-date
(reader method).
(setf version-date)
(writer method).
40ants-doc/ignored-words/file-type.lisp
40ants-doc/ignored-words
(system).
ignore-words-in-package
(macro).
ignored-words
(generic function).
supports-ignored-words-p
(generic function).
*package-ignore-words*
(special variable).
ignored-in-package
(function).
Packages are listed by definition order.
40ants-doc/locatives/base
40ants-doc/source-api
40ants-doc/object-package
40ants-doc
40ants-doc/locatives/define-definer
40ants-doc/locatives
40ants-doc/glossary
40ants-doc/docstring
40ants-doc/ignored-words
40ants-doc/reference
40ants-doc/restart
40ants-doc/changelog
40ants-doc/reference-api
40ants-doc/locatives/base
common-lisp
.
define-locative-type
(macro).
locate
(function).
locate-and-find-source
(generic function).
locate-error
(function).
locate-error
(condition).
locate-error-locative
(generic reader).
locate-error-message
(generic reader).
locate-error-object
(generic reader).
locate-object
(generic function).
locative-args
(generic function).
locative-equal
(function).
locative-type
(generic function).
locative-lambda-list
(generic function).
symbol-lambda-list
(generic function).
symbol-lambda-list-method
(function).
40ants-doc/source-api
common-lisp
.
find-source
(generic function).
40ants-doc/object-package
common-lisp
.
object-package
(generic function).
40ants-doc
See 40ANTS-DOC:@INDEX.
40ants-doc/core
common-lisp
.
*discard-documentation-p*
(special variable).
*symbols-with-ignored-missing-locations*
(special variable).
defsection
(macro).
defsection-copy
(macro).
exportable-locative-type-p
(generic function).
section
(class).
section-entries
(generic reader).
section-external-docs
(generic reader).
section-ignore-words
(generic reader).
section-link-title-to
(generic reader).
section-name
(generic reader).
section-package
(generic reader).
section-readtable
(generic reader).
section-title
(generic reader).
ensure-list
(function).
ensure-package
(function).
entry-to-reference
(function).
export-some-symbols
(function).
locative-equal
(function).
symbol-accessible-in-package-p
(function).
transform-entries
(function).
transform-link-title-to
(function).
transform-locative-symbols
(function).
40ants-doc/locatives/define-definer
common-lisp
.
expand-define-definer-for-symbol-as-locative-definer-body
(function).
40ants-doc/locatives
This package holds all symbols denoting 40ANTS-DOC locatives.
It serves for a forward declaration of supported locatives.
To build documentation you’ll need to load the 40ANTS-DOC-FULL system
which includes methods supporting these locatives.
common-lisp
.
40ants-doc/glossary
common-lisp
.
define-glossary-term
(macro).
glossary-term
(class).
glossary-term-docstring
(generic reader).
glossary-term-name
(generic reader).
glossary-term-title
(generic reader).
40ants-doc/docstring
common-lisp
.
get-docstring
(function).
strip-docstring-indentation
(function).
*whitespace-chars*
(special variable).
blankp
(function).
docstring-indentation
(function).
filter-documentation
(function).
n-leading-spaces
(function).
trim-whitespace
(function).
whitespacep
(function).
40ants-doc/ignored-words
common-lisp
.
ignore-words-in-package
(macro).
ignored-words
(generic function).
supports-ignored-words-p
(generic function).
*package-ignore-words*
(special variable).
ignored-in-package
(function).
40ants-doc/reference
common-lisp
.
make-reference
(function).
reference
(class).
reference-locative
(generic reader).
reference-object
(generic reader).
resolve
(function).
*reference-being-documented*
(special variable).
*references*
(special variable).
external-reference
(class).
external-reference-p
(function).
external-reference-url
(generic reader).
make-external-reference
(function).
reference-locative-type
(function).
reference-to-anchor
(function).
reference=
(function).
references-for-symbol
(function).
references-for-the-same-symbol-p
(function).
resolve-dislocated
(function).
resolve-generic-function-and-methods
(function).
40ants-doc/changelog
common-lisp
.
@changelog
(special variable).
defchangelog
(macro).
0.1.0
(special variable).
0.10.0
(special variable).
0.11.0
(special variable).
0.11.1
(special variable).
0.11.2
(special variable).
0.12.0
(special variable).
0.13.0
(special variable).
0.14.0
(special variable).
0.15.0
(special variable).
0.15.1
(special variable).
0.2.0
(special variable).
0.3.0
(special variable).
0.4.0
(special variable).
0.4.1
(special variable).
0.5.0
(special variable).
0.5.1
(special variable).
0.5.2
(special variable).
0.5.3
(special variable).
0.5.4
(special variable).
0.5.5
(special variable).
0.5.6
(special variable).
0.5.7
(special variable).
0.5.8
(special variable).
0.6.0
(special variable).
0.7.0
(special variable).
0.8.0
(special variable).
0.9.0
(special variable).
0.9.1
(special variable).
0.9.2
(special variable).
@index
(special variable).
changelog
(class).
looks-like-date
(function).
make-version-section
(function).
split-date-if-given
(function).
version
(class).
version-date
(generic reader).
(setf version-date)
(generic writer).
40ants-doc/reference-api
common-lisp
.
*source-uri-fn*
(special variable).
canonical-reference
(generic function).
source-uri
(function).
reference-name
(generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The default value of DEFSECTION’s DISCARD-DOCUMENTATION-P argument. One may want to set ‘*DISCARD-DOCUMENTATION-P*‘ to true before building a binary application.
Set this to a function of one argument.
The argument of this function will be a 40ANTS-DOC/REFERENCE:REFERENCE
object and the result should be a full URL leading to the web page where
referenced object can be viewed. Usually this is a GitHub’s page.
When you are using 40ANTS-DOC-FULL/BUILDER:UPDATE-ASDF-SYSTEM-DOCS,
this variable will be automatically bound to the result of
40ANTS-DOC-FULL/GITHUB:MAKE-GITHUB-SOURCE-URI-FN function call if
ASDF system has a :SOURCE-CONTROL slot.
See 40ANTS-DOC-FULL/GITHUB:MAKE-GITHUB-SOURCE-URI-FN for details.
Sometimes code might be generated without source location attached.
For example Mito generates slot readers this way.
Such symbols should be added to this list to skip warnings during the documentation build.
Use such code to add a new symbol to ignore:
“‘lisp
(eval-when (:compile-toplevel :load-toplevel :execute)
(pushnew ’reblocks-auth/models:profile-user
40ants-doc:*symbols-with-ignored-missing-locations*))
“‘
This macro might be used to define a ChangeLog in a structured way.
With DEFCHANGELOG you specify a body where each sublist starts with
a version number and the rest is it’s description in the markdown
format. You can mention symbols from the rest of the documentation
and they will be cross-linked automatically if you are using
40ANTS-DOC-FULL/BUILDER:UPDATE-ASDF-SYSTEM-DOCS function.
Here is an example:
“‘lisp
(defchangelog ()
(0.2.0
"- Feature B implemented.
- Bug was fixed in function FOO.")
(0.1.0
"- Project forked from [MGL-PAX](https://github.com/melisgl/mgl-pax).
- Feature A implemented."))
“‘
Define a macro with NAME which can be used to attach documentation, a lambda-list and source location to a symbol in the context of LOCATIVE-TYPE. The defined macro’s arglist is (SYMBOL LAMBDA-LIST &OPTIONAL DOCSTRING). LOCATIVE-TYPE is assumed to have been defined with 40ANTS-DOC-FULL/LOCATIVES/DEFINERS:DEFINE-SYMBOL-LOCATIVE-TYPE.
Define a global variable with NAME and set it to a glossary term
object. A glossary term is just a symbol to hang a docstring on. It
is a bit like a 40ANTS-DOC:SECTION in that, when linked to, its TITLE will be
the link text instead of the name of the symbol. Unlike sections
though, glossary terms are not rendered with headings, but in the
more lightweight bullet + locative + name/title style.
When DISCARD-DOCUMENTATION-P (defaults to 40ANTS-DOC:*DISCARD-DOCUMENTATION-P*) is true, DOCSTRING will not be recorded to save memory.
Declare LOCATIVE-TYPE as a locative. One gets two
things in return: first, a place to document the format and
semantics of LOCATIVE-TYPE (in LAMBDA-LIST and DOCSTRING); second,
being able to reference ‘(LOCATIVE-TYPE LOCATIVE)‘. For example, if
you have:
“‘lisp
(define-locative-type variable (&optional initform)
"Dummy docstring.")
“‘
then ‘(VARIABLE LOCATIVE)‘ refers to this form.
A definer macro to hang the documentation of a restart on a
symbol.
“‘
(define-restart my-ignore-error ()
"Available when MY-ERROR is signalled, MY-IGNORE-ERROR unsafely continues.")
“‘
Note that while there is a CL:RESTART class, there is no
corresponding source location or docstring like for CONDITIONs.
Define a documentation section and maybe export referenced symbols.
A bit behind the scenes, a global variable with NAME is defined and
is bound to a [SECTION][class] object. By convention, section names
start with the character ‘@‘. See ‘40ANTS-DOC-FULL/DOC::@TUTORIAL‘ for an example.
ENTRIES consists of docstrings and references. Docstrings are
arbitrary strings in markdown format, references are defined in the
forms:
(symbol locative) or ((symbol1 symbol2 ... symboln) locative)
For example, ‘(FOO FUNCTION)‘ refers to the function ‘FOO‘, ‘(@BAR
SECTION)‘ says that ‘@BAR‘ is a subsection of this
one. ‘(BAZ (METHOD () (T T T)))‘ refers to the default method of the
three argument generic function ‘BAZ‘. ‘(FOO FUNCTION)‘ is
equivalent to ‘(FOO (FUNCTION))‘.
A locative in a reference can either be a symbol or it can be a list
whose CAR is a symbol. In either case, the symbol is the called the
type of the locative while the rest of the elements are the locative
arguments. See 40ANTS-DOC-FULL/DOC::@LOCATIVE-TYPES for the list of locative
types available out of the box.
The same symbol can occur multiple times in ENTRIES, typically
with different locatives, but this is not required.
The references are not looked up (see 40ANTS-DOC/REFERENCE:RESOLVE in the
40ANTS-DOC-FULL/DOC:@EXTENSION-API) until documentation is generated, so it is
allowed to refer to things yet to be defined.
If you set :EXPORT to true, the referenced symbols and NAME are
candidates for exporting. A candidate symbol is exported if
- it is accessible in PACKAGE (it’s not ‘OTHER-PACKAGE:SOMETHING‘)
and
- there is a reference to it in the section being defined with a
locative whose type is approved by EXPORTABLE-LOCATIVE-TYPE-P.
The original idea with confounding documentation and exporting is to force
documentation of all exported symbols. However when forking MGL-PAX into
40ANTS-DOC I’ve decided explicit imports make code more readable, and
changed the default for :EXPORT argument to NIL and added automatic
warnings to help find exported symbols not referenced from the documention.
If you decide to use ‘:EXPORT t‘ argument, note it will cause
[package variance](http://www.sbcl.org/manual/#Package-Variance)
error on SBCL. To prevent it, use UIOP:DEFINE-PACKAGE instead
of CL:DEFPACKAGE.
:TITLE is a non-marked-up string or NIL. If non-nil, it determines
the text of the heading in the generated output. :LINK-TITLE-TO is a
reference given as an
‘(OBJECT LOCATIVE)‘ pair or NIL, to which the heading will link when
generating HTML. If not specified, the heading will link to its own
anchor.
When :DISCARD-DOCUMENTATION-P (defaults to *DISCARD-DOCUMENTATION-P*)
is true, ENTRIES will not be recorded to save memory.
EXTERNAL-DOCS argument can be a list of URLs leading to documentation
of other libraries. These libraries should be documented using 40ANTS-DOC
and you’ll be able to mention symbols from them and have automatic
cross-links.
EXTERNAL-LINKS argument could contain an alist of ("name" . "URL") pairs.
These pairs will be tranformed to [name]: URL text and appended to each
markdown part of the defined chapter. This argument is useful when you are
having more than one text part in the chapter and want to reference same
URL from all of them using short markdown links.
:IGNORE-WORDS allows to pass a list of strings which should not cause
warnings. Usually these are uppercased words which are not symbols
in the current package, like SLIME, LISP, etc.
When you use [DOCS-BUILDER](https://40ants.com/docs-builder), you might want
to define a @readme variable to make README.md file with the same content as
your main documentation. This case might be popular for libraries having
a short documentation.
To define @readme as a copy of the main doc, export @readme symbol and do this in the code:
“‘lisp
(defparameter @readme (40ants-doc:copy-section @index))
“‘
Adds given symbols or string to ignore list bound to the current package.
You will not be warned when one of these symbols is not documented or documented and not exported from the package.
Follow LOCATIVE from OBJECT and return the object it leads to or a
40ANTS-DOC/REFERENCE:REFERENCE if there is no first class object corresponding to the
location. If ERRORP, then a LOCATE-ERROR condition is signaled when
the lookup fails.
Call this function to signal a LOCATE-ERROR condition from a
LOCATE-OBJECT generic-function. FORMAT-AND-ARGS contains a format string and
args suitable for FORMAT from which the LOCATE-ERROR-MESSAGE is
constructed. If FORMAT-AND-ARGS is NIL, then the message will be NIL
too.
The object and the locative are not specified, they are added by
LOCATE when it resignals the condition.
Compares two locatives.
Each locative may be a symbol or a locative with arugments in a list form.
A convenience function to 40ANTS-DOC/LOCATIVES/BASE:LOCATE REFERENCE’s object with its locative.
Returns URI for the reference object
if *SOURCE-URI-FN* is bound to a function.
Normalize indentation of docstrings
Return a 40ANTS-DOC/REFERENCE:REFERENCE that resolves to OBJECT.
Return true if symbols in references with
LOCATIVE-TYPE are to be exported when they occur in a
DEFSECTION having ‘:EXPORT t‘ argument. The default method returns T, while the methods for
PACKAGE, ASDF:SYSTEM and METHOD return NIL.
DEFSECTION calls this function to decide what symbols to export when
its EXPORT argument is true.
Like SWANK:FIND-DEFINITION-FOR-THING, but this
one is a generic function to be extensible. In fact, the default
implementation simply defers to SWANK:FIND-DEFINITION-FOR-THING.
This function is called by 40ANTS-DOC-FULL/SWANK:LOCATE-DEFINITION-FOR-EMACS which lies
behind the ‘M-.‘ extension (see 40ANTS-DOC-FULL/DOC:@EMACS-INTEGRATION).
If successful, the return value looks like this:
“‘lisp
(:location (:file "/home/mega/own/mgl/pax/test/test.lisp")
(:position 24) nil)
“‘
The NIL is the source snippet which is optional. Note that position
1 is the first character. If unsuccessful, the return values is
like:
“‘lisp
(:error "Unknown source location for SOMETHING")
“‘
reference
)) ¶If REFERENCE can be resolved to a non-reference, call 40ANTS-DOC/SOURCE-API:FIND-SOURCE generic-function with it, else call [40ANTS-DOC/LOCATIVES/BASE:LOCATE-AND-FIND-SOURCE][generic-function] on the object, locative-type, locative-args slots of REFERENCE.
Returns a list of words or symbols to ignore in OBJ’s documentation.
package
)) ¶Called by [40ANTS-DOC/SOURCE-API:FIND-SOURCE][(METHOD () (40ANTS-DOC/REFERENCE:REFERENCE))]
on 40ANTS-DOC/REFERENCE:REFERENCE objects, this
function has essentially the same purpose as 40ANTS-DOC/SOURCE-API:FIND-SOURCE generic-function but it has
different arguments to allow specializing on LOCATIVE-TYPE.
This default implementation simply calls 40ANTS-DOC/SOURCE-API:FIND-SOURCE with OBJECT
which should cover the common case of a macro expanding to, for
instance, a defun but having its own locative type.
locate-error
)) ¶locate-error
)) ¶locate-error
)) ¶Return the object, to which OBJECT and the locative
refer. For example, if LOCATIVE-TYPE is the symbol PACKAGE, this
returns ‘(FIND-PACKAGE SYMBOL)‘. Signal a LOCATE-ERROR condition by
calling the LOCATE-ERROR function if the lookup fails. Signal other
errors if the types of the argument are bad, for instance
LOCATIVE-ARGS is not the empty list in the package example. If a
40ANTS-DOC/REFERENCE:REFERENCE is returned then it must be canonical in the sense that
calling 40ANTS-DOC/REFERENCE-API:CANONICAL-REFERENCE on it will return the same reference.
For extension only, don’t call this directly.
The REST of LOCATIVE if it’s a list. If it’s a symbol then it’s ().
The first element of LOCATIVE if it’s a list. If it’s a symbol then it’s that symbol itself. Typically, methods of generic functions working with locatives take locative type and locative args as separate arguments to allow methods have eql specializers on the type symbol.
Should return ‘T‘ if objects implements a method for IGNORED-WORDS generic-function.
glossary-term
) stream) ¶Signaled by LOCATE when the lookup fails and ERRORP is true.
A REFERENCE represents a path (REFERENCE-LOCATIVE) to take from an object (REFERENCE-OBJECT).
DEFSECTION stores its :NAME, :TITLE, :PACKAGE, :READTABLE and :ENTRIES in [SECTION][class] objects.
The name of the global variable whose value is this SECTION object.
symbol
:name
This slot is read-only.
*PACKAGE* will be bound to this package when generating documentation for this section.
common-lisp
.
package
:package
This slot is read-only.
*READTABLE* will be bound to this when generating documentation for this section.
common-lisp
.
:readtable
This slot is read-only.
STRING or NIL. Used in generated documentation.
:title
This slot is read-only.
A 40ANTS-DOC/REFERENCE:REFERENCE or NIL. Used in generated documentation.
:link-title-to
This slot is read-only.
A list of strings and 40ANTS-DOC/REFERENCE:REFERENCE objects in the order they occurred in DEFSECTION.
:entries
This slot is read-only.
A list of strings with URLs of other system’s documentation.
:external-docs
This slot is read-only.
A list of strings to not warn about.
:ignore-words
This slot is read-only.
If LIST is a list, it is returned. Otherwise returns the list designated by LIST.
Checks if given symbol or string is ignored in a package.
Receives a list of entities and if first entity is a date in format 2021-09-24, then this date is removed from the content and returned as the first value. Rest entries are returned as the second value.
external-reference
)) ¶automatically generated reader method
url
.
glossary-term
)) ¶automatically generated reader method
glossary-term
)) ¶The name of the global variable whose value is this GLOSSARY-TERM object.
name
.
glossary-term
)) ¶Used in generated documentation.
version
)) ¶version
)) ¶This slot will contain a date in it’s unparsed form, as a string.
Because we don’t want to introduce dependency from LOCAL-TIME system for
changelog definition. This value will be parsed later, when we’ll generate output.
date
.
A full URL of external entity.
string
:url
This slot is read-only.
The name of the global variable whose value is this GLOSSARY-TERM object.
:name
This slot is read-only.
Used in generated documentation.
:title
This slot is read-only.
:docstring
This slot is read-only.
This slot will contain a date in it’s unparsed form, as a string.
Because we don’t want to introduce dependency from LOCAL-TIME system for
changelog definition. This value will be parsed later, when we’ll generate output.
(or null string)
:date
Jump to: | (
B C D E F G I L M N O P R S T V W |
---|
Jump to: | (
B C D E F G I L M N O P R S T V W |
---|
Jump to: | *
0
@
D E I L M N O P R S T U |
---|
Jump to: | *
0
@
D E I L M N O P R S T U |
---|
Jump to: | 4
C E F G L P R S V |
---|
Jump to: | 4
C E F G L P R S V |
---|