The main functions
The main function nothing After loading the package, run it with the name of the package you want to create a documentation of as first argument. Make sure you have included this file as source if you run your &GAPDoc; documentation creating script. The second argument is a path to the directory where it can store the &GAPDoc; XML files. It will produce several files out of the Declare*WithDoc declarations you have used in your package package_name, and one named AutoDocMainFile.xml, which you can simply include to your documentation. section_intros is optional, it must be a list containing lists of of either two or three strings. If two are given, first one must be a chapter title, with underscores instead of spaces, and the second one a string which will be displayed in the documentation at the beginning of the chapter. If three are given, first one must be a chapter, second a section, third the description.
Global variable This global variable stores all the streams and some additional data, like chapter names.
The declare functions nothing This method declares an operation, like DeclareOperation( name, list_of_filters ) would do. In addition, it specifies various information documenting the declared operation. They can be used to generate &GAPDoc; documentation files by calling in a suitable way.
The additional parameters have the following meaning: description This contains a descriptive text which is added to the generated documentation. It can either be a string or a list of strings. If it is a list of strings, then these strings are concatenated with a space between them. return_value A string displayed as description of the return value. arguments An optional string which is displayed in the documentation as arguments list of the operation. chapter_and_section An optional argument which, if present, must be a list of two strings, naming the chapter and the section in which the generated documentation for the operation should be placed. There are no spaces allowed in this string, underscores will be converted to spaces in the header of the chapter or the section. option_record option_record can be a record with some additional options. The following are currently supported: group This must be a string and is used to group functions with the same group name together in the documentation. Their description will be concatenated, chapter and section info of the first element in the group will be used. function_label This sets the label of the function to the string function_label. It might be useful for reference purposes, also this string is displayed as argument of this method in the manual. This really sets the label of the function, not the label of the ManItem. Please see the &GAPDoc; manual for more infos on labels and references. nothing This method declares a category, like DeclareCategory( name, filter ) would do.
The remaining parameters behave as described for . nothing This method declares a representation, like DeclareRepresentation( name, filter, list_of_req_entries ) would do.
The remaining parameters behave as described for . nothing This method declares an attribute, like DeclareAttribute( name, filter ) would do.
The remaining parameters behave as described for . nothing This method declares a property, like DeclareProperty( name, filter ) would do.
The remaining parameters behave as described for . nothing This method declares a global function like DeclareGlobalFunction( name ) would do.
The remaining parameters behave as described for . nothing This method declares a global variable like DeclareGlobalVariable( name ) would do.
The remaining parameters behave as described for . nothing This method declares an operation, like DeclareOperation( name, list_of_filters ) would do. In addition, it specifies various information documenting the declared operation. There can be used to generate &GAPDoc; documentation files by calling in a suitable way.
The remaining parameters are all optional and are passed via GAP's function call with options syntax. For example, you might write

        DeclareOperationWithDoc( "SomeOp", [IsInt] : description := "desc" )

in order to declare an operation with a certain description text. For details on the options syntax, see . All of them are optional, a documentation entry will be created even if you specify none of them. The additional parameters have the following meaning: description This contains a descriptive text which is added to the generated documentation. It can either be a string or a list of strings. If it is a list of strings, then these strings are concatenated with a space between them. return_value A string displayed as description of the return value. arguments An optional string which is displayed in the documentation as arguments list of the operation. chapter_info An optional argument which, if present, must be a list of two strings, naming the chapter and the section in which the generated documentation for the operation should be placed. There are no spaces allowed in this string, underscores will be converted to spaces in the header of the chapter or the section. group This must be a string and is used to group functions with the same group name together in the documentation. Their description will be concatenated, chapter and section info of the first element in the group will be used. function_label This sets the label of the function to the string function_label. It might be useful for reference purposes, also this string is displayed as argument of this method in the manual. This really sets the label of the function, not the label of the ManItem. Please see the &GAPDoc; manual for more infos on labels and references. nothing This method declares a category, like DeclareCategory( arg ) would do.
The remaining options behave as described for . nothing This method declares a representation, like DeclareRepresentation( arg ) would do.
The remaining options behave as described for . nothing This method declares an attribute, like DeclareAttribute( arg ) would do.
The remaining options behave as described for . nothing This method declares a property, like DeclareProperty( arg ) would do.
The remaining parameters behave as described for . nothing This method declares a global function like DeclareGlobalFunction( arg ) would do.
The remaining parameters behave as described for . nothing This method declares a global variable like DeclareGlobalVariable( arg ) would do.
The remaining parameters behave as described for .
The install functions nothing This method installs a method, like InstallMethod( name, short_descr, list_of_filters, func ) would do.
The remaining parameters behave as described for . nothing This method installs a method, like InstallMethod( arg ) would do.
The remaining parameters behave as described for .
The create functions nothing This works like except that it does not call DeclareCategory. nothing This works like except that it does not call DeclareRepresentation. nothing This works like except that it does not call DeclareOperation. nothing This works like except that it does not call DeclareAttribute. nothing This works like except that it does not call DeclareProperty. nothing Does the same as Declare*WithDoc but without declaring anything.
Additional functions These functions set or reset a current chapter or section, which will be applied to entries without a chapter_info instead of the default one. Note that setting a section without a chapter does nothing, and reseting the chapter also resets the section. Writes a string or a list of strings given as argument description into doc. chapter_info is optional, but without a current chapter set, this would cause an error. Also it is possible here to only give the chapter, not the section. It will be written in the chapter at the current point, i.e. after the last written section.