summaryrefslogtreecommitdiffstats
path: root/.pytool/Plugin/UncrustifyCheck/default_function_header.txt
blob: 66edc72e6731eadd06d4df39a572c8359b3c5973 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
  Brief description of this function's purpose.

  Follow it immediately with the detailed description.

  @param[in]      Arg1  Description of Arg1.
  @param[in]      Arg2  Description of Arg2 This is complicated and requires
                        multiple lines to describe.
  @param[out]     Arg3  Description of Arg3.
  @param[in, out] Arg4  Description of Arg4.

  @retval VAL_ONE  Description of what VAL_ONE signifies.
  @retval OTHER    This is the only other return value. If there were other
                   return values, they would be listed.
**/