GAP (AutoDoc) - Contents

Goto Chapter: Top 1 2 3 4 Bib Ind
[Top of Book] [Contents] [Next Chapter]

[MathJax off]

# AutoDoc

## Generate documentation from GAP source code

2026.05.11

11 May 2026

Sebastian Gutsche
Email: gutsche@mathematik.uni-siegen.de
Homepage: https://algebra.mathematik.uni-siegen.de/gutsche/
Address:
Department Mathematik
Universität Siegen
Walter-Flex-Straße 3
57072 Siegen
Germany

Max Horn
Email: mhorn@rptu.de
Homepage: https://www.quendi.de/math
Address:
Fachbereich Mathematik
RPTU Kaiserslautern-Landau
Gottlieb-Daimler-Straße 48
67663 Kaiserslautern
Germany

### Abstract

AutoDoc is a GAP package whose purpose is to aid GAP package authors in creating and maintaining the documentation of their packages.

### Copyright

© 2012-2026 by Sebastian Gutsche and Max Horn

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

### Acknowledgements

This documentation was prepared using the GAPDoc package [LN24].

### Contents

1 What AutoDoc offers
1.1 Core features
1.2 Adopting AutoDoc incrementally
1.3 Where to continue
2 Getting started using AutoDoc
2.1 Choose your workflow
2.2 Creating a package manual from scratch
2.3 Documenting code with AutoDoc
2.4 Using AutoDoc in an existing GAPDoc manual
2.4-1 Using AutoDoc on a complete GAPDoc manual
2.4-2 Setting different GAPDoc options
2.4-3 Checklist for converting an existing GAPDoc manual to use AutoDoc
2.5 Scaffolds
2.5-1 Generating a title page
2.5-2 Generating the main XML file
2.5-3 What data is used from `PackageInfo.g`?
2.5-4 Entities from `PackageInfo.g` and scaffold options
2.6 Worksheets
3 AutoDoc documentation comments
3.1 Documenting declarations
3.1-1 `@Description descr`
3.1-2 `@Returns ret val`
3.1-3 `@Arguments args`
3.1-4 `@ItemType kind`
3.1-5 `@Group grpname`
3.1-6 `@Label label`
3.1-7 `@ChapterInfo chapter, section`
3.2 Other documentation comments
3.2-1 `@Chapter name`
3.2-2 `@Appendix name`
3.2-3 `@Section name`
3.2-4 `@Subsection name`
3.2-5 `@BeginGroup [grpname]`
3.2-6 `@EndGroup`
3.2-7 @GroupTitle title
3.2-8 `@BeginExample` and `@EndExample`
3.2-9 `@BeginExampleSession` and `@EndExampleSession`
3.2-10 `@BeginLog` and `@EndLog`
3.2-11 `@BeginLogSession` and `@EndLogSession`
3.2-12 `@DoNotReadRestOfFile`
3.2-13 `@BeginChunk name`, `@EndChunk`, and `@InsertChunk name`
3.2-14 `@BeginCode name`, @EndCode, and `@InsertCode name`
3.2-15 `@LatexOnly text`, `@BeginLatexOnly`, and `@EndLatexOnly`
3.2-16 `@NotLatex text`, `@BeginNotLatex`, and `@EndNotLatex`
3.2-17 `@Index key [entry text]`
3.3 Title page commands
3.4 Plain text files
3.5 Grouping
3.6 Markdown-like formatting of text in AutoDoc
3.6-1 Lists
3.6-2 Math modes
3.6-3 Emphasize
3.6-4 Inline code
3.6-5 Fenced code blocks
3.7 Deprecated commands
4 Reference
4.1 AutoDoc worksheets
4.1-1 AutoDocWorksheet
4.2 The AutoDoc() function
4.2-1 AutoDoc
4.2-2 InfoAutoDoc
References
Index
[Top of Book] [Contents] [Next Chapter]
Goto Chapter: Top 1 2 3 4 Bib Ind

generated by GAPDoc2HTML