Bug in HeaderTool

Development Programming & Scripting C++
, , ,
1

Hi,

I’ve discovered a bug with the parsing HeaderTool.

If you header files contains comment formatted like below :

The tool fails and don’t give the adequate error.

/** @brief Values that represent EKFontTypeEnum.  
/** @remark Add new value here when you need to have   
/**         a specific font type. */

I make hours to understand that the header tool fails to parse the comment.

You have to be sure the comment is formatted like this :

/** @brief Values that represent EKFontTypeEnum.  
 *  @remark Add new value here when you need to have   
 *          a specific font type. 
 */

I hope this will help someone have problem errors reported by the HeaderTool.

Dominique

2

Hi Dominique,

Thank you for bringing this issue up to us. By our coding standards, the second method you provided is the correct way and those can be found here: Epic C++ Coding Standard for Unreal Engine | Unreal Engine 5.1 Documentation

Even though those are our standards, I can’t see why your original format shouldn’t work. I’ve put in a bug report for it and while I hope it’ll be fixed, I can’t guarantee that it will be changed. For your reference, the bug number is UE-15788

Have a nice day

3

Thank you very much.

D.

4

Hey,

Thanks for bringing this up. Issue should be fixed in CL#2605847 (.com/EpicGames/UnrealEngine/commit/446dc2f2d58d4c88cecfa3b79858e71a1e546ce6).

Cheers,
Mikolaj