/usr/share/doc/racket/scribble/doc-signatures.html is in racket-doc 6.7-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="content-type" content="text/html; charset=utf-8"/><title>4.3.5 Documenting Signatures</title><link rel="stylesheet" type="text/css" href="../scribble.css" title="default"/><link rel="stylesheet" type="text/css" href="../racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-style.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../manual-racket.css" title="default"/><link rel="stylesheet" type="text/css" href="../doc-site.css" title="default"/><script type="text/javascript" src="../scribble-common.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../manual-racket.js"></script><script type="text/javascript" src="../doc-site.js"></script><script type="text/javascript" src="../local-redirect/local-redirect.js"></script><script type="text/javascript" src="../local-redirect/local-user-redirect.js"></script><!--[if IE 6]><style type="text/css">.SIEHidden { overflow: hidden; }</style><![endif]--></head><body id="doc-racket-lang-org"><div class="tocset"><div class="tocview"><div class="tocviewlist tocviewlisttopspace"><div class="tocviewtitle"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_0");">►</a></td><td></td><td><a href="index.html" class="tocviewlink" data-pltdoc="x">Scribble:<span class="mywbr"> </span> The Racket Documentation Tool</a></td></tr></table></div><div class="tocviewsublisttop" style="display: none;" id="tocview_0"><table cellspacing="0" cellpadding="0"><tr><td align="right">1 </td><td><a href="getting-started.html" class="tocviewlink" data-pltdoc="x">Getting Started</a></td></tr><tr><td align="right">2 </td><td><a href="reader.html" class="tocviewlink" data-pltdoc="x">@ Syntax</a></td></tr><tr><td align="right">3 </td><td><a href="generic-prose.html" class="tocviewlink" data-pltdoc="x">High-<wbr></wbr>Level Scribble API</a></td></tr><tr><td align="right">4 </td><td><a href="plt-manuals.html" class="tocviewselflink" data-pltdoc="x">Scribbling Documentation</a></td></tr><tr><td align="right">5 </td><td><a href="lp.html" class="tocviewlink" data-pltdoc="x">Literate Programming</a></td></tr><tr><td align="right">6 </td><td><a href="internals.html" class="tocviewlink" data-pltdoc="x">Low-<wbr></wbr>Level Scribble API</a></td></tr><tr><td align="right">7 </td><td><a href="running.html" class="tocviewlink" data-pltdoc="x">Running <span class="stt">scribble</span></a></td></tr><tr><td align="right"></td><td><a href="doc-index.html" class="tocviewlink" data-pltdoc="x">Index</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_1");">►</a></td><td>4 </td><td><a href="plt-manuals.html" class="tocviewlink" data-pltdoc="x">Scribbling Documentation</a></td></tr></table><div class="tocviewsublist" style="display: none;" id="tocview_1"><table cellspacing="0" cellpadding="0"><tr><td align="right">4.1 </td><td><a href="how-to-doc.html" class="tocviewlink" data-pltdoc="x">Getting Started with Documentation</a></td></tr><tr><td align="right">4.2 </td><td><a href="reference-style.html" class="tocviewlink" data-pltdoc="x">Style Guide</a></td></tr><tr><td align="right">4.3 </td><td><a href="manual.html" class="tocviewselflink" data-pltdoc="x">Manual Forms</a></td></tr><tr><td align="right">4.4 </td><td><a href="scheme.html" class="tocviewlink" data-pltdoc="x">Racket</a></td></tr><tr><td align="right">4.5 </td><td><a href="eval.html" class="tocviewlink" data-pltdoc="x">Evaluation and Examples</a></td></tr><tr><td align="right">4.6 </td><td><a href="srcdoc.html" class="tocviewlink" data-pltdoc="x">In-<wbr></wbr>Source Documentation</a></td></tr><tr><td align="right">4.7 </td><td><a href="bnf.html" class="tocviewlink" data-pltdoc="x">BNF Grammars</a></td></tr><tr><td align="right">4.8 </td><td><a href="Compatibility_Libraries.html" class="tocviewlink" data-pltdoc="x">Compatibility Libraries</a></td></tr></table></div></div><div class="tocviewlist"><table cellspacing="0" cellpadding="0"><tr><td style="width: 1em;"><a href="javascript:void(0);" title="Expand/Collapse" class="tocviewtoggle" onclick="TocviewToggle(this,"tocview_2");">▼</a></td><td>4.3 </td><td><a href="manual.html" class="tocviewlink" data-pltdoc="x">Manual Forms</a></td></tr></table><div class="tocviewsublistbottom" style="display: block;" id="tocview_2"><table cellspacing="0" cellpadding="0"><tr><td align="right">4.3.1 </td><td><a href="scribble_manual_code.html" class="tocviewlink" data-pltdoc="x">Typesetting Code</a></td></tr><tr><td align="right">4.3.2 </td><td><a href="doc-modules.html" class="tocviewlink" data-pltdoc="x">Documenting Modules</a></td></tr><tr><td align="right">4.3.3 </td><td><a href="doc-forms.html" class="tocviewlink" data-pltdoc="x">Documenting Forms, Functions, Structure Types, and Values</a></td></tr><tr><td align="right">4.3.4 </td><td><a href="doc-classes.html" class="tocviewlink" data-pltdoc="x">Documenting Classes and Interfaces</a></td></tr><tr><td align="right">4.3.5 </td><td><a href="" class="tocviewselflink" data-pltdoc="x">Documenting Signatures</a></td></tr><tr><td align="right">4.3.6 </td><td><a href="doc-strings.html" class="tocviewlink" data-pltdoc="x">Various String Forms</a></td></tr><tr><td align="right">4.3.7 </td><td><a href="section-links.html" class="tocviewlink" data-pltdoc="x">Links</a></td></tr><tr><td align="right">4.3.8 </td><td><a href="manual-indexing.html" class="tocviewlink" data-pltdoc="x">Indexing</a></td></tr><tr><td align="right">4.3.9 </td><td><a href="Bibliography.html" class="tocviewlink" data-pltdoc="x">Bibliography</a></td></tr><tr><td align="right">4.3.10 </td><td><a href="Version_History.html" class="tocviewlink" data-pltdoc="x">Version History</a></td></tr><tr><td align="right">4.3.11 </td><td><a href="Miscellaneous.html" class="tocviewlink" data-pltdoc="x">Miscellaneous</a></td></tr><tr><td align="right">4.3.12 </td><td><a href="index-entries.html" class="tocviewlink" data-pltdoc="x">Index-<wbr></wbr>Entry Descriptions</a></td></tr><tr><td align="right">4.3.13 </td><td><a href="manual-render-style.html" class="tocviewlink" data-pltdoc="x">Manual Rendering Style</a></td></tr></table></div></div></div><div class="tocsub"><div class="tocsubtitle">On this page:</div><table class="tocsublist" cellspacing="0"><tr><td><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defsignature%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktStxLink">defsignature</span></span></a></td></tr><tr><td><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defsignature%2Fsplice%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktStxLink">defsignature/<span class="mywbr"> </span>splice</span></span></a></td></tr><tr><td><a href="#%28def._%28%28lib._scribble%2Fmanual..rkt%29._signature-desc%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktValLink">signature-<wbr></wbr>desc</span></span></a></td></tr><tr><td><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._sigelem%29%29" class="tocsublink" data-pltdoc="x"><span class="RktSym"><span class="RktStxLink">sigelem</span></span></a></td></tr></table></div></div><div class="maincolumn"><div class="main"><div class="navsettop"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <a href="doc-classes.html" title="backward to "4.3.4 Documenting Classes and Interfaces"" data-pltdoc="x">← prev</a> <a href="manual.html" title="up to "4.3 Manual Forms"" data-pltdoc="x">up</a> <a href="doc-strings.html" title="forward to "4.3.6 Various String Forms"" data-pltdoc="x">next →</a></span> </div><h5 x-source-module="(lib "scribblings/scribble/scribble.scrbl")" x-source-pkg="scribble-doc" x-part-tag=""doc-signatures"">4.3.5<tt> </tt><a name="(part._doc-signatures)"></a>Documenting Signatures</h5><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>syntax</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(form._((lib._scribble/manual..rkt)._defsignature))"></a><span title="Provided from: scribble/manual | Package: scribble-lib"><span class="RktSym"><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defsignature%29%29" class="RktStxDef RktStxLink" data-pltdoc="x">defsignature</a></span></span><span class="hspace"> </span><span class="RktVar">id</span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktVar">super-id</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktVar">pre-flow</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span></p></blockquote></td></tr></table></blockquote></div><div class="SIntrapara">Defines a signature <span class="RktVar">id</span> that extends the <span class="RktVar">super-id</span>
signatures. Any elements defined in <a href="decode.html#%28tech._decode%29" class="techoutside" data-pltdoc="x"><span class="techinside">decode</span></a>d
<span class="RktVar">pre-flow</span>s—<wbr></wbr>including forms, procedures, structure types,
classes, interfaces, and mixins—<wbr></wbr>are defined as members of the
signature instead of direct bindings. These definitions can be
referenced through <span class="RktSym"><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._sigelem%29%29" class="RktStxLink" data-pltdoc="x">sigelem</a></span> instead of <span class="RktSym"><a href="scribble_manual_code.html#%28form._%28%28lib._scribble%2Fmanual..rkt%29._racket%29%29" class="RktStxLink" data-pltdoc="x">racket</a></span>.</div></p><p>The <a href="decode.html#%28tech._decode%29" class="techoutside" data-pltdoc="x"><span class="techinside">decode</span></a>d <span class="RktVar">pre-flow</span>s inset under the signature
declaration in the typeset output, so no new sections, etc<span class="Sendabbrev">.</span> can be
started.</p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>syntax</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(form._((lib._scribble/manual..rkt)._defsignature/splice))"></a><span title="Provided from: scribble/manual | Package: scribble-lib"><span class="RktSym"><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defsignature%2Fsplice%29%29" class="RktStxDef RktStxLink" data-pltdoc="x">defsignature/splice</a></span></span><span class="hspace"> </span><span class="RktVar">id</span><span class="hspace"> </span><span class="RktPn">(</span><span class="RktVar">super-id</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span><span class="hspace"> </span><span class="RktVar">pre-flow</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span></p></blockquote></td></tr></table></blockquote></div><div class="SIntrapara">Like <span class="RktSym"><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defsignature%29%29" class="RktStxLink" data-pltdoc="x">defsignature</a></span>, but the <a href="decode.html#%28tech._decode%29" class="techoutside" data-pltdoc="x"><span class="techinside">decode</span></a>d <span class="RktVar">pre-flow</span>s
are not typeset under the signature declaration, and new sections,
etc<span class="Sendabbrev">.</span> can be started in the <span class="RktVar">pre-flow</span>s.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>procedure</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(def._((lib._scribble/manual..rkt)._signature-desc))"></a><span title="Provided from: scribble/manual | Package: scribble-lib"><span class="RktSym"><a href="#%28def._%28%28lib._scribble%2Fmanual..rkt%29._signature-desc%29%29" class="RktValDef RktValLink" data-pltdoc="x">signature-desc</a></span></span><span class="hspace"> </span><span class="RktVar">pre-flow</span><span class="hspace"> </span><span class="RktMeta">...</span><span class="RktPn">)</span><span class="hspace"> </span>→<span class="hspace"> </span><span class="RktSym"><a href="https://download.racket-lang.org/docs/6.7/html/local-redirect/index.html?doc=reference&rel=data-structure-contracts.html%23%2528def._%2528%2528lib._racket%252Fcontract%252Fprivate%252Fmisc..rkt%2529._any%252Fc%2529%2529&version=6.7" class="RktValLink Sq" data-pltdoc="x">any/c</a></span></p></blockquote></td></tr><tr><td><span class="hspace"> </span><span class="RktVar">pre-flow</span><span class="hspace"> </span>:<span class="hspace"> </span><span class="RktSym"><a href="decode.html#%28def._%28%28lib._scribble%2Fdecode..rkt%29._pre-flow~3f%29%29" class="RktValLink" data-pltdoc="x">pre-flow?</a></span></td></tr></table></blockquote></div><div class="SIntrapara">Produces an opaque value that <span class="RktSym"><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defsignature%29%29" class="RktStxLink" data-pltdoc="x">defsignature</a></span> recognizes to
outdent in the typeset form. This is useful for text describing the
signature as a whole to appear right after the signature declaration.</div></p><p><div class="SIntrapara"><blockquote class="SVInsetFlow"><table cellspacing="0" cellpadding="0" class="boxed RBoxed"><tr><td><blockquote class="SubFlow"><div class="RBackgroundLabel SIEHidden"><div class="RBackgroundLabelInner"><p>syntax</p></div></div><p class="RForeground"><span class="RktPn">(</span><a name="(form._((lib._scribble/manual..rkt)._sigelem))"></a><span title="Provided from: scribble/manual | Package: scribble-lib"><span class="RktSym"><a href="#%28form._%28%28lib._scribble%2Fmanual..rkt%29._sigelem%29%29" class="RktStxDef RktStxLink" data-pltdoc="x">sigelem</a></span></span><span class="hspace"> </span><span class="RktVar">sig-id</span><span class="hspace"> </span><span class="RktVar">id</span><span class="RktPn">)</span></p></blockquote></td></tr></table></blockquote></div><div class="SIntrapara">Typesets the identifier <span class="RktVar">id</span> with a hyperlink to its definition
as a member of the signature named by <span class="RktVar">sig-id</span>.</div></p><div class="navsetbottom"><span class="navleft"><form class="searchform"><input class="searchbox" style="color: #888;" type="text" value="...search manuals..." title="Enter a search string to search the manuals" onkeypress="return DoSearchKey(event, this, "6.7", "../");" onfocus="this.style.color="black"; this.style.textAlign="left"; if (this.value == "...search manuals...") this.value="";" onblur="if (this.value.match(/^ *$/)) { this.style.color="#888"; this.style.textAlign="center"; this.value="...search manuals..."; }"/></form> <a href="../index.html" title="up to the documentation top" data-pltdoc="x" onclick="return GotoPLTRoot("6.7");">top</a></span><span class="navright"> <a href="doc-classes.html" title="backward to "4.3.4 Documenting Classes and Interfaces"" data-pltdoc="x">← prev</a> <a href="manual.html" title="up to "4.3 Manual Forms"" data-pltdoc="x">up</a> <a href="doc-strings.html" title="forward to "4.3.6 Various String Forms"" data-pltdoc="x">next →</a></span> </div></div></div><div id="contextindicator"> </div></body></html>
|