GAP (AutoDoc) - Contents

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.

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

1 Getting started using AutoDoc

1.1 Creating a package manual from scratch

1.2 Documenting code with AutoDoc

1.3 Using AutoDoc in an existing GAPDoc manual

  1.3-1 Using AutoDoc on a complete GAPDoc manual
  1.3-2 Setting different GAPDoc options
  1.3-3 Checklist for converting an existing GAPDoc manual to use AutoDoc

1.4 Scaffolds

  1.4-1 Generating a title page
  1.4-2 Generating the main XML file
  1.4-3 What data is used from PackageInfo.g?

1.5 AutoDoc worksheets

2 AutoDoc documentation comments

2.1 Documenting declarations

  2.1-1 @Description descr
  2.1-2 @Returns ret_val
  2.1-3 @Arguments args
  2.1-4 @Group grpname
  2.1-5 @Label label
  2.1-6 AProperty
  2.1-7 AProperty
  2.1-8 @ChapterInfo chapter, section

2.2 Other documentation comments

  2.2-1 @Chapter name
  2.2-2 @Section name
  2.2-3 @Subsection name
  2.2-4 @BeginGroup [grpname]
  2.2-5 @EndGroup
  2.2-6 @GroupTitle title
  2.2-7 @Level lvl
  2.2-8 @ResetLevel
  2.2-9 @BeginExample and @EndExample
  2.2-10 @BeginExampleSession and @EndExampleSession
  2.2-11 @BeginLog and @EndLog
  2.2-12 @BeginLogSession and @EndLogSession
  2.2-13 @DoNotReadRestOfFile
  2.2-14 @BeginChunk name, @EndChunk, and @InsertChunk name
  2.2-15 @BeginCode name, @EndCode, and @InsertCode name
  2.2-16 @LatexOnly text, @BeginLatexOnly, and @EndLatexOnly
  2.2-17 @NotLatex text, @BeginNotLatex, and @EndNotLatex

2.3 Title page commands

2.4 Plain text files

2.5 Grouping

2.5-1 A family of operations

2.6 Level

2.7 Markdown-like formatting of text in AutoDoc

  2.7-1 Lists
  2.7-2 Math modes
  2.7-3 Emphasize
  2.7-4 Inline code

2.8 Deprecated commands

3 AutoDoc worksheets

3.1 Worksheets

3.1-1 AutoDocWorksheet

4 AutoDoc

4.1 The AutoDoc() function

4.1-1 AutoDoc

4.2 Examples

References

Index

AutoDoc

Generate documentation from GAP source code

Abstract

Copyright

Acknowledgements

Contents