Tags, depending on type, generally require either one field of information or two:

• @function [FunctionName]

• @param [parameterName] [Some descriptive text...]

In the tables below, the “Fields” column indicates the number of textual fields each type of tag takes.

Contents:

Introduction to HeaderDoc Comments and Tags
Multiword Names
Automatic Tagging
Tags for Frameworks
Tags for All Headers
Tags Common to All API Types
Tags for All Languages
C Pseudoclass Tags
Tags for C++ Headers
Tags for Objective-C Headers