Indexing requirements

When this document is built an index is also constructed. There are a few code items that you must place in the index.

$\bullet$

Functions must be entered in the index, so users can find them. The \idx{} command should be right after the prototypes themselves are entered. This insures the page number that appear in the index will be the page where the prototype is explained in the document. Use the LAL L^ATEX command

  \idx{MyFunction()}

$\bullet$

Non LAL Data Structures must appear in the index. The LAL-Spec strongly encourages the using LAL datatypes as the arguments for a function, but this isn't always possible. If you do use non-LAL datatypes, you must document them, and they must be included the index, so someone looking at your code can easily find the documentation. The \idx[Type]{} command should be right after in the section where they are explained in the documentation. Here is an example of the LAL L^ATEX command you would use to get the name of your structure into the index.

  \idx[Type]{MyType}

$\bullet$

Other Indexable Things should also be indexed. If the thing is a constant variable, a constant-like macro, or an enum constant, index it using \idx[Constant]{thing}. If the thing is a function-like macro, index it using \idx{thing} (which is equivalent to \idx[Function]{thing}). If it is a macro that is non-function-like and non-constant-like then index it using \idx[Macro]{thing}. If the thing is a variable (including function-like variables) then index it using \idx[Variable]{thing}. If the thing is a concept, then just use the standard L^ATEX command \index{thing}.