  
  
                                   [1X AutoDoc [101X
  
  
                 [1X Generate documentation from [5XGAP[105X source code [101X
  
  
                                   2023.06.19
  
  
                                  19 June 2023
  
  
                               Sebastian Gutsche
  
                                    Max Horn
  
  
  
  Sebastian Gutsche
      Email:    [7Xmailto:gutsche@mathematik.uni-siegen.de[107X
      Homepage: [7Xhttps://algebra.mathematik.uni-siegen.de/gutsche/[107X
      Address:  [33X[0;14YDepartment Mathematik[133X
                [33X[0;14YUniversität Siegen[133X
                [33X[0;14YWalter-Flex-Straße 3[133X
                [33X[0;14Y57072 Siegen[133X
                [33X[0;14YGermany[133X
  
  
  Max Horn
      Email:    [7Xmailto:mhorn@rptu.de[107X
      Homepage: [7Xhttps://www.quendi.de/math[107X
      Address:  [33X[0;14YFachbereich Mathematik[133X
                [33X[0;14YRPTU Kaiserslautern-Landau[133X
                [33X[0;14YGottlieb-Daimler-Straße 48[133X
                [33X[0;14Y67663 Kaiserslautern[133X
                [33X[0;14YGermany[133X
  
  
  
  -------------------------------------------------------
  [1XAbstract[101X
  [33X[0;0Y[5XAutoDoc[105X  is  a  [5XGAP[105X  package  whose purpose is to aid [5XGAP[105X package authors in
  creating and maintaining the documentation of their packages.[133X
  
  
  -------------------------------------------------------
  [1XCopyright[101X
  [33X[0;0Y© 2012-2022 by Sebastian Gutsche and Max Horn[133X
  
  [33X[0;0YThis  package  may  be distributed under the terms and conditions of the GNU
  Public License Version 2 or (at your option) any later version.[133X
  
  
  -------------------------------------------------------
  [1XAcknowledgements[101X
  [33X[0;0YThis documentation was prepared using the [5XGAPDoc[105X package [LN12].[133X
  
  
  -------------------------------------------------------
  
  
  [1XContents (AutoDoc)[101X
  
  1 [33X[0;0YGetting started using [5XAutoDoc[105X[133X
    1.1 [33X[0;0YCreating a package manual from scratch[133X
    1.2 [33X[0;0YDocumenting code with [5XAutoDoc[105X[133X
    1.3 [33X[0;0YUsing [5XAutoDoc[105X in an existing [5XGAPDoc[105X manual[133X
      1.3-1 [33X[0;0YUsing [5XAutoDoc[105X on a complete [5XGAPDoc[105X manual[133X
      1.3-2 [33X[0;0YSetting different [5XGAPDoc[105X options[133X
      1.3-3 [33X[0;0YChecklist for converting an existing [5XGAPDoc[105X manual to use [5XAutoDoc[105X[133X
    1.4 [33X[0;0YScaffolds[133X
      1.4-1 [33X[0;0YGenerating a title page[133X
      1.4-2 [33X[0;0YGenerating the main XML file[133X
      1.4-3 [33X[0;0YWhat data is used from [11XPackageInfo.g[111X?[133X
    1.5 [33X[0;0YAutoDoc worksheets[133X
  2 [33X[0;0Y[5XAutoDoc[105X documentation comments[133X
    2.1 [33X[0;0YDocumenting declarations[133X
      2.1-1 [33X[0;0Y[10X@Description [3Xdescr[103X[10X[110X[133X
      2.1-2 [33X[0;0Y[10X@Returns [3Xret_val[103X[10X[110X[133X
      2.1-3 [33X[0;0Y[10X@Arguments [3Xargs[103X[10X[110X[133X
      2.1-4 [33X[0;0Y[10X@Group [3Xgrpname[103X[10X[110X[133X
      2.1-5 [33X[0;0Y[10X@Label [3Xlabel[103X[10X[110X[133X
      2.1-6 AProperty
      2.1-7 AProperty
      2.1-8 [33X[0;0Y[10X@ChapterInfo [3Xchapter[103X[10X, [3Xsection[103X[10X[110X[133X
    2.2 [33X[0;0YOther documentation comments[133X
      2.2-1 [33X[0;0Y[10X@Chapter [3Xname[103X[10X[110X[133X
      2.2-2 [33X[0;0Y[10X@Section [3Xname[103X[10X[110X[133X
      2.2-3 [33X[0;0Y[10X@Subsection [3Xname[103X[10X[110X[133X
      2.2-4 [33X[0;0Y[10X@BeginGroup [3X[grpname][103X[10X[110X[133X
      2.2-5 [33X[0;0Y[10X@EndGroup[110X[133X
      2.2-6 [33X[0;0Y@GroupTitle [3Xtitle[103X[133X
      2.2-7 [33X[0;0Y[10X@Level [3Xlvl[103X[10X[110X[133X
      2.2-8 [33X[0;0Y[10X@ResetLevel[110X[133X
      2.2-9 [33X[0;0Y[10X@BeginExample[110X and [10X@EndExample[110X[133X
      2.2-10 [33X[0;0Y[10X@BeginExampleSession[110X and [10X@EndExampleSession[110X[133X
      2.2-11 [33X[0;0Y[10X@BeginLog[110X and [10X@EndLog[110X[133X
      2.2-12 [33X[0;0Y[10X@BeginLogSession[110X and [10X@EndLogSession[110X[133X
      2.2-13 [33X[0;0Y[10X@DoNotReadRestOfFile[110X[133X
      2.2-14 [33X[0;0Y[10X@BeginChunk [3Xname[103X[10X[110X, [10X@EndChunk[110X, and [10X@InsertChunk [3Xname[103X[10X[110X[133X
      2.2-15 [33X[0;0Y[10X@BeginCode [3Xname[103X[10X[110X, @EndCode, and [10X@InsertCode [3Xname[103X[10X[110X[133X
      2.2-16 [33X[0;0Y[10X@LatexOnly [3Xtext[103X[10X[110X, [10X@BeginLatexOnly[110X, and [10X@EndLatexOnly[110X[133X
      2.2-17 [33X[0;0Y[10X@NotLatex [3Xtext[103X[10X[110X, [10X@BeginNotLatex[110X, and [10X@EndNotLatex[110X[133X
    2.3 [33X[0;0YTitle page commands[133X
    2.4 [33X[0;0YPlain text files[133X
    2.5 [33X[0;0YGrouping[133X
      2.5-1 [33X[0;0YA family of operations[133X
    2.6 [33X[0;0YLevel[133X
    2.7 [33X[0;0YMarkdown-like formatting of text in [5XAutoDoc[105X[133X
      2.7-1 [33X[0;0YLists[133X
      2.7-2 [33X[0;0YMath modes[133X
      2.7-3 [33X[0;0YEmphasize[133X
      2.7-4 [33X[0;0YInline code[133X
    2.8 [33X[0;0YDeprecated commands[133X
  3 [33X[0;0YAutoDoc worksheets[133X
    3.1 [33X[0;0YWorksheets[133X
      3.1-1 AutoDocWorksheet
  4 [33X[0;0YAutoDoc[133X
    4.1 [33X[0;0YThe AutoDoc() function[133X
      4.1-1 AutoDoc
    4.2 [33X[0;0YExamples[133X
  
  
  [32X
