Provides an "Applies To" description. The "Applies To" section allows the developer the capability to group functional procedures in the final compiled output. Note the default organization of returns data, transactional, updates data, and cursors remains.
If a tag is found at the batch level, it must have been defined at the SQLHelp.ini level or it will be ignored.
Batch: -- ##AT Section
SQLHelp.ini: -- ##AT Section ^^ Comment
Where Section is
the name of the applies to section the developer wishes to group procedures by,
and Comment is
the documentation text to use
-- ##AT Product Catalogue
--##AT Product Catalogue ^^ These procedures are designed to work with the
automated update
--##AT Product Catalogue ^^ process of the product catalogue.
The following example shows the sample.chm file provided in the installation package. We have the default groupings of Modifies Data, Returns Data, Transactional, Examples and Executes Procedures along with the user defined grouping of UserProfile. Not shown is the Uncategorized grouping which contains those procedures which are neither transactional, use cursors or modify data.
All procedures that are associated with the grouping, either through the default logic, of expressly included by the AT tag are listed.