Quellcodebibliothek Statistik Leitseite products/Sources/formale Sprachen/C/Apache/docs/manual/   (Apache Software Stiftung Version 2.4.65©)  Datei vom 19.0.2025 mit Größe 19 kB image not shown  

Quelle  chap0.html   Sprache: unbekannt

 
<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>GAP (AutoDoc) - Contents</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<meta name="generator" content="GAPDoc2HTML" />
<link rel="stylesheet" type="text/css" href="manual.css" />
<script src="manual.js" type="text/javascript"></script>
<script type="text/javascript">overwriteStyle();</script>
</head>
<body class="chap0"  onload="jscontent()">


<div class="chlinktop"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<div class="chlinkprevnexttop"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap1.html">[Next Chapter]</a>   </div>

<p id="mathjaxlink" class="pcenter"><a href="chap0_mj.html">[MathJax on]</a></p>
<p><a id="X7D2C85EC87DD46E5" name="X7D2C85EC87DD46E5"></a></p>
<div class="pcenter">

<h1>AutoDoc</h1>


<h2>Generate documentation from <strong class="pkg">GAP</strong> source code</h2>

<p>
    2025.10.16</p>

<p>
    16 October 2025
  </p>

</div>
<p><b>
    Sebastian Gutsche




  </b>
<br />Email: <span class="URL"><a href="mailto:gutsche@mathematik.uni-siegen.de">gutsche@mathematik.uni-siegen.de</a></span>
<br />Homepage: <span class="URL"><a href="https://algebra.mathematik.uni-siegen.de/gutsche/">https://algebra.mathematik.uni-siegen.de/gutsche/</a></span>
<br />Address: <br />Department Mathematik<br /> Universität Siegen<br /> Walter-Flex-Straße 3<br /> 57072 Siegen<br /> Germany<br />
</p><p><b>
    Max Horn




  </b>
<br />Email: <span class="URL"><a href="mailto:mhorn@rptu.de">mhorn@rptu.de</a></span>
<br />Homepage: <span class="URL"><a href="https://www.quendi.de/math">https://www.quendi.de/math</a></span>
<br />Address: <br />Fachbereich Mathematik<br /> RPTU Kaiserslautern-Landau<br /> Gottlieb-Daimler-Straße 48<br /> 67663 Kaiserslautern<br /> Germany<br />
</p>

<p><a id="X7AA6C5737B711C89" name="X7AA6C5737B711C89"></a></p>
<h3>Abstract</h3>
<p><strong class="pkg">AutoDoc</strong> is a <strong class="pkg">GAP</strong> package whose purpose is to aid <strong class="pkg">GAP</strong> package authors in creating and maintaining the documentation of their packages.</p>

<p><a id="X81488B807F2A1CF1" name="X81488B807F2A1CF1"></a></p>
<h3>Copyright</h3>
<p>© 2012-2022 by Sebastian Gutsche and Max Horn</p>

<p>This package may be distributed under the terms and conditions of the GNU Public License Version 2 or (at your option) any later version.</p>

<p><a id="X82A988D47DFAFCFA" name="X82A988D47DFAFCFA"></a></p>
<h3>Acknowledgements</h3>
<p>This documentation was prepared using the <strong class="pkg">GAPDoc</strong> package <a href="chapBib.html#biBGAPDoc">[LN12]</a>.</p>

<p><a id="X8537FEB07AF2BEC8" name="X8537FEB07AF2BEC8"></a></p>

<div class="contents">
<h3>Contents<a id="contents" name="contents"></a></h3>

<div class="ContChap"><a href="chap1.html#X7A0D7AA484F466E1">1 <span class="Heading">Getting started using <strong class="pkg">AutoDoc</strong></span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap1.html#X7BFBC6907B26AA95">1.1 <span class="Heading">Creating a package manual from scratch</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap1.html#X87A00EED866E22E8">1.2 <span class="Heading">Documenting code with <strong class="pkg">AutoDoc</strong></span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap1.html#X7FA614637B807F4D">1.3 <span class="Heading">Using <strong class="pkg">AutoDoc</strong> in an existing <strong class="pkg">GAPDoc</strong> manual</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap1.html#X7F3CEB097AF47C1E">1.3-1 <span class="Heading">Using <strong class="pkg">AutoDoc</strong> on a complete <strong class="pkg">GAPDoc</strong> manual</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap1.html#X7D0DDF2284F2D24A">1.3-2 <span class="Heading">Setting different <strong class="pkg">GAPDoc</strong> options</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap1.html#X83448D91868D7994">1.3-3 <span class="Heading">
Checklist for converting an existing <strong class="pkg">GAPDoc</strong> manual to use <strong class="pkg">AutoDoc</strong>
</span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap1.html#X8524193D824CDE0D">1.4 <span class="Heading">Scaffolds</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap1.html#X7CF22DE28478316F">1.4-1 <span class="Heading">Generating a title page</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap1.html#X7CD72CC780874FD5">1.4-2 <span class="Heading">Generating the main XML file</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap1.html#X799956EA85D3FC15">1.4-3 <span class="Heading">What data is used from <code class="file">PackageInfo.g</code>?</span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap1.html#X80ED3C2A78146AD1">1.5 <span class="Heading">AutoDoc worksheets</span></a>
</span>
</div>
</div>
<div class="ContChap"><a href="chap2.html#X87668C487B1A2094">2 <span class="Heading"><strong class="pkg">AutoDoc</strong> documentation comments</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X871482CE838C68F6">2.1 <span class="Heading">Documenting declarations</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7F1D85188262A827">2.1-1 <span class="Heading"><code class="code">@Description <var class="Arg">descr</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7DCAB2F87E8FAE90">2.1-2 <span class="Heading"><code class="code">@Returns <var class="Arg">ret_val</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X81DAA454857F7971">2.1-3 <span class="Heading"><code class="code">@Arguments <var class="Arg">args</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X8677FE8F80C00B14">2.1-4 <span class="Heading"><code class="code">@Group <var class="Arg">grpname</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7B0E20A27D64DF6F">2.1-5 <span class="Heading"><code class="code">@Label <var class="Arg">label</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X83B63B847B5199CF">2.1-6 AProperty</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X78A9022A7D5CB20E">2.1-7 AProperty</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X78938EE37A532FFA">2.1-8 <span class="Heading"><code class="code">@ChapterInfo <var class="Arg">chapter</var>, <var class="Arg">section</var></code></span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X8152FEF9844B1ACD">2.2 <span class="Heading">Other documentation comments</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X823E613385D09F6F">2.2-1 <span class="Heading"><code class="code">@Chapter <var class="Arg">name</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X78AA98BA7E0635D0">2.2-2 <span class="Heading"><code class="code">@Section <var class="Arg">name</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7FD77434802A3580">2.2-3 <span class="Heading"><code class="code">@Subsection <var class="Arg">name</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7D3060C17EDBCED1">2.2-4 <span class="Heading"><code class="code">@BeginGroup <var class="Arg">[grpname]</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7C17EB007FD42C87">2.2-5 <span class="Heading"><code class="code">@EndGroup</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X82FB96F37FAE8167">2.2-6 <span class="Heading">@GroupTitle <var class="Arg">title</var></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7BF81EAF80D1A4B5">2.2-7 <span class="Heading"><code class="code">@Level <var class="Arg">lvl</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7C6723D57F424215">2.2-8 <span class="Heading"><code class="code">@ResetLevel</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X83D6DA3B83D3436C">2.2-9 <span class="Heading"><code class="code">@BeginExample</code> and <code class="code">@EndExample</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X861E2E778510CAF7">2.2-10 <span class="Heading"><code class="code">@BeginExampleSession</code> and <code class="code">@EndExampleSession</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X81A2D44D834C0A17">2.2-11 <span class="Heading"><code class="code">@BeginLog</code> and <code class="code">@EndLog</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7BADE876794FF309">2.2-12 <span class="Heading"><code class="code">@BeginLogSession</code> and <code class="code">@EndLogSession</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X78DC644E8519280C">2.2-13 <span class="Heading"><code class="code">@DoNotReadRestOfFile</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X83C01F9B7FA1C973">2.2-14 <span class="Heading"><code class="code">@BeginChunk <var class="Arg">name</var></code>, <code class="code">@EndChunk</code>, and <code class="code">@InsertChunk <var class="Arg">name</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7D3671AF86B995B9">2.2-15 <span class="Heading"><code class="code">@BeginCode <var class="Arg">name</var></code>, @EndCode, and <code class="code">@InsertCode <var class="Arg">name</var></code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X8033B34F80A12A10">2.2-16 <span class="Heading"><code class="code">@LatexOnly <var class="Arg">text</var></code>, <code class="code">@BeginLatexOnly</code>, and <code class="code">@EndLatexOnly</code></span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7EF303147F1BCC22">2.2-17 <span class="Heading"><code class="code">@NotLatex <var class="Arg">text</var></code>, <code class="code">@BeginNotLatex</code>, and <code class="code">@EndNotLatex</code></span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X841E3AD584F5385C">2.3 <span class="Heading">Title page commands</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X828AE38F80CB02E7">2.4 <span class="Heading">Plain text files</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X7D7A38F87BC40C48">2.5 <span class="Heading">Grouping</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X79BF060F8436C586">2.5-1 <span class="Heading">A family of operations</span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X8209AFDE8209AFDE">2.6 <span class="Heading">Level</span></a>
</span>
</div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X79558A2F7FE187B4">2.7 <span class="Heading">Markdown-like formatting of text in <strong class="pkg">AutoDoc</strong></span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7B256AE5780F140A">2.7-1 <span class="Heading">Lists</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X871412737A0E12E2">2.7-2 <span class="Heading">Math modes</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X7ED0330479146EFC">2.7-3 <span class="Heading">Emphasize</span></a>
</span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap2.html#X838CCDEB7E0ECEE2">2.7-4 <span class="Heading">Inline code</span></a>
</span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap2.html#X78CA9E5C7F494C19">2.8 <span class="Heading">Deprecated commands</span></a>
</span>
</div>
</div>
<div class="ContChap"><a href="chap3.html#X80ED3C2A78146AD1">3 <span class="Heading">AutoDoc worksheets</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap3.html#X801D4A2F8292704C">3.1 <span class="Heading">Worksheets</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap3.html#X809FE4137C08B28D">3.1-1 AutoDocWorksheet</a></span>
</div></div>
</div>
<div class="ContChap"><a href="chap4.html#X7CBD8AAF7DCEF352">4 <span class="Heading">AutoDoc</span></a>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap4.html#X863584DB8497D8BA">4.1 <span class="Heading">The AutoDoc() function</span></a>
</span>
<div class="ContSSBlock">
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap4.html#X7CBD8AAF7DCEF352">4.1-1 AutoDoc</a></span>
<span class="ContSS"><br /><span class="nocss">  </span><a href="chap4.html#X81F946A785BA3D6E">4.1-2 InfoAutoDoc</a></span>
</div></div>
<div class="ContSect"><span class="tocline"><span class="nocss"> </span><a href="chap4.html#X7A489A5D79DA9E5C">4.2 <span class="Heading">Examples</span></a>
</span>
</div>
</div>
<div class="ContChap"><a href="chapBib.html"><span class="Heading">References</span></a></div>
<div class="ContChap"><a href="chapInd.html"><span class="Heading">Index</span></a></div>
<br />
</div>

<div class="chlinkprevnextbot"> <a href="chap0.html">[Top of Book]</a>   <a href="chap0.html#contents">[Contents]</a>    <a href="chap1.html">[Next Chapter]</a>   </div>


<div class="chlinkbot"><span class="chlink1">Goto Chapter: </span><a href="chap0.html">Top</a>  <a href="chap1.html">1</a>  <a href="chap2.html">2</a>  <a href="chap3.html">3</a>  <a href="chap4.html">4</a>  <a href="chapBib.html">Bib</a>  <a href="chapInd.html">Ind</a>  </div>

<hr />
<p class="foot">generated by <a href="https://www.math.rwth-aachen.de/~Frank.Luebeck/GAPDoc">GAPDoc2HTML</a></p>
</body>
</html>

100%


[ Konzepte0.26Was zu einem Entwurf gehört  Wie die Entwicklung von Software durchgeführt wird  ]