The 40ants-doc Reference Manual

3.1.1 40ants-doc/40ants-doc.asd

Source

40ants-doc.asd.

Parent Component

40ants-doc (system).

ASDF Systems

• 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.

---

3.1.2 40ants-doc/core/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/core (system).

Packages

40ants-doc.

Public Interface

• *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).

Internals

• 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).

---

3.1.3 40ants-doc/reference/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/reference (system).

Packages

40ants-doc/reference.

Public Interface

• canonical-reference (method).
• find-source (method).
• make-reference (function).
• print-object (method).
• reference (class).
• reference-locative (reader method).
• reference-object (reader method).
• resolve (function).

Internals

• *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).

---

3.1.4 40ants-doc/reference-api/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/reference-api (system).

Packages

40ants-doc/reference-api.

Public Interface

• *source-uri-fn* (special variable).
• canonical-reference (generic function).
• source-uri (function).

Internals

reference-name (generic function).

---

3.1.5 40ants-doc/source-api/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/source-api (system).

Packages

40ants-doc/source-api.

Public Interface

find-source (generic function).

---

3.1.6 40ants-doc/locatives/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/locatives (system).

Packages

40ants-doc/locatives.

---

3.1.7 40ants-doc/locatives/base/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/locatives/base (system).

Packages

40ants-doc/locatives/base.

Public Interface

• 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).

Internals

• locative-lambda-list (generic function).
• symbol-lambda-list (generic function).
• symbol-lambda-list-method (function).

---

3.1.8 40ants-doc/object-package/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/object-package (system).

Packages

40ants-doc/object-package.

Internals

object-package (generic function).

---

3.1.9 40ants-doc/docstring/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/docstring (system).

Packages

40ants-doc/docstring.

Public Interface

• get-docstring (function).
• strip-docstring-indentation (function).

Internals

• *whitespace-chars* (special variable).
• blankp (function).
• docstring-indentation (function).
• filter-documentation (function).
• n-leading-spaces (function).
• trim-whitespace (function).
• whitespacep (function).

---

3.1.10 40ants-doc/restart/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/restart (system).

Packages

40ants-doc/restart.

Public Interface

define-restart (macro).

---

3.1.11 40ants-doc/locatives/define-definer/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/locatives/define-definer (system).

Packages

40ants-doc/locatives/define-definer.

Public Interface

define-definer-for-symbol-locative-type (macro).

Internals

expand-define-definer-for-symbol-as-locative-definer-body (function).

---

3.1.12 40ants-doc/glossary/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/glossary (system).

Packages

40ants-doc/glossary.

Public Interface

• define-glossary-term (macro).
• print-object (method).

Internals

• glossary-term (class).
• glossary-term-docstring (reader method).
• glossary-term-name (reader method).
• glossary-term-title (reader method).

---

3.1.13 40ants-doc/changelog/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/changelog (system).

Packages

40ants-doc/changelog.

Public Interface

• @changelog (special variable).
• defchangelog (macro).

Internals

• 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).

---

3.1.14 40ants-doc/ignored-words/file-type.lisp

Source

40ants-doc.asd.

Parent Component

40ants-doc/ignored-words (system).

Packages

40ants-doc/ignored-words.

Public Interface

• ignore-words-in-package (macro).
• ignored-words (generic function).
• supports-ignored-words-p (generic function).

Internals

• *package-ignore-words* (special variable).
• ignored-in-package (function).

---

5.1.1 Special variables

Special Variable: *discard-documentation-p* ¶

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.

Package

40ants-doc.

Source

file-type.lisp.

Special Variable: *source-uri-fn* ¶

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.

Package

40ants-doc/reference-api.

Source

file-type.lisp.

Special Variable: *symbols-with-ignored-missing-locations* ¶

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*))
“‘

Package

40ants-doc.

Source

file-type.lisp.

Special Variable: @changelog ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

---

5.1.2 Macros

Macro: defchangelog ((&key title ignore-words external-docs external-links) &body versions) ¶

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."))
“‘

Package

40ants-doc/changelog.

Source

file-type.lisp.

Macro: define-definer-for-symbol-locative-type (name locative-type &body docstring) ¶

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.

Package

40ants-doc/locatives/define-definer.

Source

file-type.lisp.

Macro: define-glossary-term (name (&key title discard-documentation-p) docstring) ¶

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.

Package

40ants-doc/glossary.

Source

file-type.lisp.

Macro: define-locative-type (locative-type lambda-list &body docstring) ¶

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.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Macro: define-restart (symbol lambda-list &body docstring) ¶

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.

Package

40ants-doc/restart.

Source

file-type.lisp.

Macro: defsection (name (&key package package-symbol readtable-symbol section-class export title link-title-to discard-documentation-p external-docs external-links ignore-words) &body entries) ¶

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.

Package

40ants-doc.

Source

file-type.lisp.

Macro: defsection-copy (name section) ¶

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))
“‘

Package

40ants-doc.

Source

file-type.lisp.

Macro: ignore-words-in-package (&rest symbols-or-strings) ¶

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.

Package

40ants-doc/ignored-words.

Source

file-type.lisp.

---

5.1.3 Ordinary functions

Function: get-docstring (object doc-type) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Function: locate (object locative &key errorp) ¶

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.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Function: locate-error (&rest format-and-args) ¶

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.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Function: locative-equal (left right) ¶

Compares two locatives.

Each locative may be a symbol or a locative with arugments in a list form.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Function: make-reference (object locative) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: resolve (reference &key errorp) ¶

A convenience function to 40ANTS-DOC/LOCATIVES/BASE:LOCATE REFERENCE’s object with its locative.

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: source-uri (reference) ¶

Returns URI for the reference object
if *SOURCE-URI-FN* is bound to a function.

Package

40ants-doc/reference-api.

Source

file-type.lisp.

Function: strip-docstring-indentation (docstring &key first-line-special-p) ¶

Normalize indentation of docstrings

Package

40ants-doc/docstring.

Source

file-type.lisp.

---

5.1.4 Generic functions

Generic Function: canonical-reference (object) ¶

Return a 40ANTS-DOC/REFERENCE:REFERENCE that resolves to OBJECT.

Package

40ants-doc/reference-api.

Source

file-type.lisp.

Methods

Method: canonical-reference ((reference reference)) ¶

Source

file-type.lisp.

Generic Function: exportable-locative-type-p (locative-type) ¶

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.

Package

40ants-doc.

Source

file-type.lisp.

Methods

Method: exportable-locative-type-p ((locative-type (eql method))) ¶

Method: exportable-locative-type-p ((locative-type (eql package))) ¶

Method: exportable-locative-type-p ((locative-type (eql asdf/system:system))) ¶

Method: exportable-locative-type-p (locative-type) ¶

Generic Function: find-source (object) ¶

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")
“‘

Package

40ants-doc/source-api.

Source

file-type.lisp.

Methods

Method: find-source ((reference 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.

Source

file-type.lisp.

Generic Function: ignored-words (obj) ¶

Returns a list of words or symbols to ignore in OBJ’s documentation.

Package

40ants-doc/ignored-words.

Source

file-type.lisp.

Methods

Method: ignored-words ((obj package)) ¶

Generic Function: locate-and-find-source (object locative-type locative-args) ¶

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.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Methods

Method: locate-and-find-source (object locative-type locative-args) ¶

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.

Generic Reader: locate-error-locative (condition) ¶

Package

40ants-doc/locatives/base.

Methods

Reader Method: locate-error-locative ((condition locate-error)) ¶

Source

file-type.lisp.

Target Slot

locative.

Generic Reader: locate-error-message (condition) ¶

Package

40ants-doc/locatives/base.

Methods

Reader Method: locate-error-message ((condition locate-error)) ¶

Source

file-type.lisp.

Target Slot

message.

Generic Reader: locate-error-object (condition) ¶

Package

40ants-doc/locatives/base.

Methods

Reader Method: locate-error-object ((condition locate-error)) ¶

Source

file-type.lisp.

Target Slot

object.

Generic Function: locate-object (object locative-type locative-args) ¶

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.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Generic Function: locative-args (locative) ¶

The REST of LOCATIVE if it’s a list. If it’s a symbol then it’s ().

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Methods

Method: locative-args ((locative list)) ¶

Method: locative-args (locative) ¶

Generic Function: locative-type (locative) ¶

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.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Methods

Method: locative-type ((locative list)) ¶

Method: locative-type ((locative symbol)) ¶

Generic Reader: reference-locative (object) ¶

Package

40ants-doc/reference.

Methods

Reader Method: reference-locative ((reference reference)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

locative.

Generic Reader: reference-object (object) ¶

Package

40ants-doc/reference.

Methods

Reader Method: reference-object ((reference reference)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

object.

Generic Reader: section-entries (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-entries ((section section)) ¶

A list of strings and 40ANTS-DOC/REFERENCE:REFERENCE objects in the order they occurred in DEFSECTION.

Source

file-type.lisp.

Target Slot

entries.

Generic Reader: section-external-docs (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-external-docs ((section section)) ¶

A list of strings with URLs of other system’s documentation.

Source

file-type.lisp.

Target Slot

external-docs.

Generic Reader: section-ignore-words (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-ignore-words ((section section)) ¶

A list of strings to not warn about.

Source

file-type.lisp.

Target Slot

ignore-words.

Generic Reader: section-link-title-to (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-link-title-to ((section section)) ¶

A 40ANTS-DOC/REFERENCE:REFERENCE or NIL. Used in generated documentation.

Source

file-type.lisp.

Target Slot

link-title-to.

Generic Reader: section-name (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-name ((section section)) ¶

The name of the global variable whose value is this SECTION object.

Source

file-type.lisp.

Target Slot

name.

Generic Reader: section-package (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-package ((section section)) ¶

*PACKAGE* will be bound to this package when generating documentation for this section.

Source

file-type.lisp.

Target Slot

package.

Generic Reader: section-readtable (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-readtable ((section section)) ¶

*READTABLE* will be bound to this when generating documentation for this section.

Source

file-type.lisp.

Target Slot

readtable.

Generic Reader: section-title (object) ¶

Package

40ants-doc.

Methods

Reader Method: section-title ((section section)) ¶

STRING or NIL. Used in generated documentation.

Source

file-type.lisp.

Target Slot

title.

Generic Function: supports-ignored-words-p (obj) ¶

Should return ‘T‘ if objects implements a method for IGNORED-WORDS generic-function.

Package

40ants-doc/ignored-words.

Source

file-type.lisp.

Methods

Method: supports-ignored-words-p (obj) ¶

Method: supports-ignored-words-p ((obj package)) ¶

---

5.1.5 Standalone methods

Method: print-object ((section section) stream) ¶

Source

file-type.lisp.

Method: print-object ((glossary-term glossary-term) stream) ¶

Source

file-type.lisp.

Method: print-object ((object reference) stream) ¶

Source

file-type.lisp.

---

5.1.6 Conditions

Condition: locate-error ¶

Signaled by LOCATE when the lookup fails and ERRORP is true.

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Direct superclasses

error.

Direct methods

• locate-error-locative.
• locate-error-message.
• locate-error-object.

Direct slots

Slot: message ¶

Initargs

:message

Readers

locate-error-message.

Writers

This slot is read-only.

Slot: object ¶

Initargs

:object

Readers

locate-error-object.

Writers

This slot is read-only.

Slot: locative ¶

Initargs

:locative

Readers

locate-error-locative.

Writers

This slot is read-only.

---

5.1.7 Classes

Class: reference ¶

A REFERENCE represents a path (REFERENCE-LOCATIVE) to take from an object (REFERENCE-OBJECT).

Package

40ants-doc/reference.

Source

file-type.lisp.

Direct subclasses

external-reference.

Direct methods

• canonical-reference.
• find-source.
• object-package.
• print-object.
• reference-locative.
• reference-object.

Direct slots

Slot: object ¶

Initargs

:object

Readers

reference-object.

Writers

This slot is read-only.

Slot: locative ¶

Initargs

:locative

Readers

reference-locative.

Writers

This slot is read-only.

Class: section ¶

DEFSECTION stores its :NAME, :TITLE, :PACKAGE, :READTABLE and :ENTRIES in [SECTION][class] objects.

Package

40ants-doc.

Source

file-type.lisp.

Direct subclasses

• changelog.
• version.

Direct methods

• object-package.
• print-object.
• section-entries.
• section-external-docs.
• section-ignore-words.
• section-link-title-to.
• section-name.
• section-package.
• section-readtable.
• section-title.

Direct slots

Slot: name ¶

The name of the global variable whose value is this SECTION object.

Type

symbol

Initargs

:name

Readers

section-name.

Writers

This slot is read-only.

Slot: package ¶

*PACKAGE* will be bound to this package when generating documentation for this section.

Package

common-lisp.

Type

package

Initargs

:package

Readers

section-package.

Writers

This slot is read-only.

Slot: readtable ¶

*READTABLE* will be bound to this when generating documentation for this section.

Package

common-lisp.

Initargs

:readtable

Readers

section-readtable.

Writers

This slot is read-only.

Slot: title ¶

STRING or NIL. Used in generated documentation.

Initargs

:title

Readers

section-title.

Writers

This slot is read-only.

Slot: link-title-to ¶

A 40ANTS-DOC/REFERENCE:REFERENCE or NIL. Used in generated documentation.

Initargs

:link-title-to

Readers

section-link-title-to.

Writers

This slot is read-only.

Slot: entries ¶

A list of strings and 40ANTS-DOC/REFERENCE:REFERENCE objects in the order they occurred in DEFSECTION.

Initargs

:entries

Readers

section-entries.

Writers

This slot is read-only.

Slot: external-docs ¶

A list of strings with URLs of other system’s documentation.

Initargs

:external-docs

Readers

section-external-docs.

Writers

This slot is read-only.

Slot: ignore-words ¶

A list of strings to not warn about.

Initargs

:ignore-words

Readers

section-ignore-words.

Writers

This slot is read-only.

---

5.2.1 Special variables

Special Variable: *package-ignore-words* ¶

Package

40ants-doc/ignored-words.

Source

file-type.lisp.

Special Variable: *reference-being-documented* ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Special Variable: *references* ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Special Variable: *whitespace-chars* ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Special Variable: 0.1.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.10.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.11.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.11.1 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.11.2 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.12.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.13.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.14.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.15.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.15.1 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.2.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.3.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.4.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.4.1 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.1 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.2 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.3 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.4 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.5 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.6 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.7 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.5.8 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.6.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.7.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.8.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.9.0 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.9.1 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: 0.9.2 ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Special Variable: @index ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

---

5.2.2 Ordinary functions

Function: blankp (string) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Function: docstring-indentation (docstring &key first-line-special-p) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Function: ensure-list (list) ¶

If LIST is a list, it is returned. Otherwise returns the list designated by LIST.

Package

40ants-doc.

Source

file-type.lisp.

Function: ensure-package (package) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: entry-to-reference (entry) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: expand-define-definer-for-symbol-as-locative-definer-body (symbol locative-type lambda-list docstring) ¶

Package

40ants-doc/locatives/define-definer.

Source

file-type.lisp.

Function: export-some-symbols (name entries package) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: external-reference-p (obj) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: filter-documentation (symbol doc-type) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Function: ignored-in-package (symbol-or-string package) ¶

Checks if given symbol or string is ignored in a package.

Package

40ants-doc/ignored-words.

Source

file-type.lisp.

Function: locative-equal (locative-1 locative-2) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: looks-like-date (item) ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Function: make-external-reference (object locative url) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: make-version-section (version content external-docs external-links) ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Function: n-leading-spaces (line) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Function: reference-locative-type (reference) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: reference-to-anchor (reference) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: reference= (reference-1 reference-2) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: references-for-symbol (symbol refs n-chars-read) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: references-for-the-same-symbol-p (refs) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: resolve-dislocated (refs) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: resolve-generic-function-and-methods (refs) ¶

Package

40ants-doc/reference.

Source

file-type.lisp.

Function: split-date-if-given (content) ¶

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.

Package

40ants-doc/changelog.

Source

file-type.lisp.

Function: symbol-accessible-in-package-p (symbol package) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: symbol-lambda-list-method (symbol locative-type) ¶

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Function: transform-entries (entries external-links) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: transform-link-title-to (link-title-to) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: transform-locative-symbols (entries) ¶

Package

40ants-doc.

Source

file-type.lisp.

Function: trim-whitespace (string) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

Function: whitespacep (char) ¶

Package

40ants-doc/docstring.

Source

file-type.lisp.

---

5.2.3 Generic functions

Generic Reader: external-reference-url (object) ¶

Package

40ants-doc/reference.

Methods

Reader Method: external-reference-url ((external-reference external-reference)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

url.

Generic Reader: glossary-term-docstring (object) ¶

Package

40ants-doc/glossary.

Methods

Reader Method: glossary-term-docstring ((glossary-term glossary-term)) ¶

automatically generated reader method

Source

file-type.lisp.

Target Slot

docstring.

Generic Reader: glossary-term-name (object) ¶

Package

40ants-doc/glossary.

Methods

Reader Method: glossary-term-name ((glossary-term glossary-term)) ¶

The name of the global variable whose value is this GLOSSARY-TERM object.

Source

file-type.lisp.

Target Slot

name.

Generic Reader: glossary-term-title (object) ¶

Package

40ants-doc/glossary.

Methods

Reader Method: glossary-term-title ((glossary-term glossary-term)) ¶

Used in generated documentation.

Source

file-type.lisp.

Target Slot

title.

Generic Function: locative-lambda-list (symbol) ¶

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Generic Function: object-package (object) ¶

Package

40ants-doc/object-package.

Source

file-type.lisp.

Methods

Method: object-package ((obj section)) ¶

Source

file-type.lisp.

Method: object-package ((obj reference)) ¶

Source

file-type.lisp.

Method: object-package (object) ¶

Generic Function: reference-name (obj name ref link) ¶

Package

40ants-doc/reference-api.

Source

file-type.lisp.

Generic Function: symbol-lambda-list (symbol locative-type) ¶

Package

40ants-doc/locatives/base.

Source

file-type.lisp.

Generic Reader: version-date (object) ¶

Generic Writer: (setf version-date) (object) ¶

Package

40ants-doc/changelog.

Methods

Reader Method: version-date ((version version)) ¶

Writer Method: (setf version-date) ((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.

Source

file-type.lisp.

Target Slot

date.

---

5.2.4 Classes

Class: changelog ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Direct superclasses

section.

Class: external-reference ¶

A full URL of external entity.

Package

40ants-doc/reference.

Source

file-type.lisp.

Direct superclasses

reference.

Direct methods

external-reference-url.

Direct slots

Slot: url ¶

Type

string

Initargs

:url

Readers

external-reference-url.

Writers

This slot is read-only.

Class: glossary-term ¶

Package

40ants-doc/glossary.

Source

file-type.lisp.

Direct methods

• glossary-term-docstring.
• glossary-term-name.
• glossary-term-title.
• print-object.

Direct slots

Slot: name ¶

The name of the global variable whose value is this GLOSSARY-TERM object.

Initargs

:name

Readers

glossary-term-name.

Writers

This slot is read-only.

Slot: title ¶

Used in generated documentation.

Initargs

:title

Readers

glossary-term-title.

Writers

This slot is read-only.

Slot: docstring ¶

Initargs

:docstring

Readers

glossary-term-docstring.

Writers

This slot is read-only.

Class: version ¶

Package

40ants-doc/changelog.

Source

file-type.lisp.

Direct superclasses

section.

Direct methods

• (setf version-date).
• version-date.

Direct slots

Slot: date ¶

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.

Type

(or null string)

Initargs

:date

Readers

version-date.

Writers

(setf version-date).

---