.pytool/Plugin/UncrustifyCheck/default_function_header.txt

   1 /**
   2   Brief description of this function's purpose.
   3
   4   Follow it immediately with the detailed description.
   5
   6   @param[in]      Arg1  Description of Arg1.
   7   @param[in]      Arg2  Description of Arg2 This is complicated and requires
   8                         multiple lines to describe.
   9   @param[out]     Arg3  Description of Arg3.
  10   @param[in, out] Arg4  Description of Arg4.
  11
  12   @retval VAL_ONE  Description of what VAL_ONE signifies.
  13   @retval OTHER    This is the only other return value. If there were other
  14                    return values, they would be listed.
  15 **/