Goto Chapter: Top 1 2 3 4 Ind

[Top of Book] [Contents] [Next Chapter]

AutoDoc

Generate documentation from GAP source code

2015.04.29

29/04/2015

Sebastian Gutsche
Email: gutsche@mathematik.uni-kl.de
Homepage: http://wwwb.math.rwth-aachen.de/~gutsche/
Address:
Department of Mathematics
University of Kaiserslautern
67653 Kaiserslautern
Germany

Max Horn
Email: max.horn@math.uni-giessen.de
Homepage: http://www.quendi.de/math
Address:
AG Algebra
Mathematisches Institut
JLU Gießen
Arndtstraße 2
D-35392 Gießen
Germany

Copyright

© 2012-2014 by Sebastian Gutsche and Max Horn

This package may be distributed under the terms and conditions of the GNU Public License Version 2.

Contents

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.4 Automatic regeneration of the manual

1.5 What is taken from PackageInfo.g

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 @EndSection
  2.2-4 @Subsection name
  2.2-5 @EndSubsection
  2.2-6 @BeginAutoDoc
  2.2-7 @EndAutoDoc
  2.2-8 @BeginGroup [grpname]
  2.2-9 @EndGroup
  2.2-10 @Level lvl
  2.2-11 @ResetLevel
  2.2-12 @BeginExample and @EndExample
  2.2-13 @BeginLog and @EndLog
  2.2-14 @DoNotReadRestOfFile
  2.2-15 @BeginChunk name, @EndChunk, and @InsertChunk name
  2.2-16 @BeginSystem name, @EndSystem, and @InsertSystem name
  2.2-17 @BeginCode name, @EndCode, and @InsertCode name
  2.2-18 @LatexOnly text, @BeginLatexOnly , and @EndLatexOnly

2.3 Title page commands

2.4 Plain text files

2.5-1 FirstOperation

2.7 Some syntax for AutoDoc text

  2.7-1 Lists
  2.7-2 Math modes
  2.7-3 Emphasize

3 AutoDoc worksheets

3.1-1 AutoDocWorksheet

4.1 The AutoDoc() function

[Top of Book] [Contents] [Next Chapter]

Goto Chapter: Top 1 2 3 4 Ind

generated by GAPDoc2HTML