74 lines
No EOL
5.1 KiB
HTML
74 lines
No EOL
5.1 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>CLiki: Declt</title>
|
|
<link rel="alternate" type="application/atom+xml" title="ATOM feed of edits to current article"
|
|
href="https://www.cliki.net/site/feed/article.atom?title=Declt">
|
|
<link rel="stylesheet" href="static/css/style.css">
|
|
<link rel="stylesheet" href="static/css/colorize.css">
|
|
</head>
|
|
|
|
<body>
|
|
<span class="hidden">CLiki - Declt</span>
|
|
<div id="content"><div id="content-area"><div id="article-title">Declt</div><div id="article">Declt (pronounce "dec'let") is a reference manual generator for
|
|
Common Lisp libraries. It works by loading an <a href="ASDF.html" class="internal">ASDF</a> system and introspecting
|
|
its contents. The generated documentation contains the description for
|
|
the system itself and its components (modules and files), the packages
|
|
defined in that system and the definitions found in those packages.<p>Exported and internal definitions are listed separately. This allows the
|
|
reader to have a quick view on the library's public API. Within each
|
|
section, definitions are sorted lexicographically.<p>In addition to <a href="ASDF.html" class="internal">ASDF</a> system components and packages, Declt documents
|
|
the following definitions: constants, special variables, symbol macros,
|
|
macros, setf expanders, compiler macros, functions (including
|
|
setf ones), generic functions and methods (including setf ones),
|
|
method combinations, conditions, structures, classes and types.<p>The generated documentation includes every possible bit of information
|
|
that introspecting can provide: documentation <a href="string.html" class="internal">string</a>s, lambda lists
|
|
(including qualifiers and specializers where appropriate), slots
|
|
(including type, allocation and initialization arguments), definition
|
|
source file etc.<p>Every documented item provides a full set of cross-references to related
|
|
items: ASDF component dependencies, parents and children, classes direct
|
|
methods, super and subclasses, slot readers and writers, <a href="https://www.cliki.net/site/HyperSpec/Body/any_setf.html" class="hyperspec">setf</a>
|
|
expanders access and update functions etc.<p>Finally, Declt produces exhaustive and multiple-entry indexes for
|
|
every documented item.<p>Reference manuals are generated in Texinfo format (compatible, but not
|
|
requiring Texinfo 5). From there it is possible to produce readable /
|
|
printable output in info, <a href="HTML.html" class="internal">HTML</a>, PDF, DVI and <a href="PostScript.html" class="internal">PostScript</a> with tools such
|
|
as makeinfo, texi2dvi or texi2pdf.<p><a href="https://www.lrde.epita.fr/~didier/software/lisp/declt/reference/">The Declt reference manual</a> is the primary example of documentation generated by Declt itself.<p>Declt's homepage is
|
|
<a href="https://www.lrde.epita.fr/~didier/software/lisp/typesetting.php#declt">here</a>.<p><hr>
|
|
Declt is a <a href="documentation tool.html" class="category">documentation tool</a> written by <a href="Didier Verna.html" class="internal">Didier Verna</a>...</div></div>
|
|
<div id="footer" class="buttonbar"><ul><li><a href="Declt.html">Current version</a></li>
|
|
<li><a href="https://www.cliki.net/site/history?article=Declt">History</a></li>
|
|
<li><a href="https://www.cliki.net/site/backlinks?article=Declt">Backlinks</a></li><li><a href="https://www.cliki.net/site/edit-article?title=Declt&from-revision=3802623235">Edit</a></li><li><a href="https://www.cliki.net/site/edit-article?create=t">Create</a></li></ul></div>
|
|
</div>
|
|
<div id="header-buttons" class="buttonbar">
|
|
<ul>
|
|
<li><a href="https://www.cliki.net/">Home</a></li>
|
|
<li><a href="https://www.cliki.net/site/recent-changes">Recent Changes</a></li>
|
|
<li><a href="CLiki.html">About</a></li>
|
|
<li><a href="Text Formatting.html">Text Formatting</a></li>
|
|
<li><a href="https://www.cliki.net/site/tools">Tools</a></li>
|
|
</ul>
|
|
<div id="search">
|
|
<form action="https://www.cliki.net/site/search">
|
|
<label for="search_query" class="hidden">Search CLiki</label>
|
|
<input type="text" name="query" id="search_query" value="" />
|
|
<input type="submit" value="search" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<div id="pageheader">
|
|
<div id="header">
|
|
<span id="logo">CLiki</span>
|
|
<span id="slogan">the common lisp wiki</span>
|
|
<div id="login"><form method="post" action="https://www.cliki.net/site/login">
|
|
<label for="login_name" class="hidden">Account name</label>
|
|
<input type="text" name="name" id="login_name" class="login_input" />
|
|
<label for= "login_password" class="hidden">Password</label>
|
|
<input type="password" name="password" id="login_password" class="login_input" />
|
|
<input type="submit" name="login" value="login" id="login_submit" /><br />
|
|
<div id="register"><a href="https://www.cliki.net/site/register">register</a></div>
|
|
<input type="submit" name="reset-pw" value="reset password" id="reset_pw" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</body></html> |