uncrustify
uncrustify copied to clipboard
Configuration documentation has no definitions
The file /documentation/htdocs/default.cfg does not define any of its terms, making it largely meaningless and unusable. For example, around line 2700, the following options fail to provide any information about the terms "span", "threshold" and "gap". After using uncrustify for more than 5 years (along with 30 years of programming experience and a PhD), I can make no meaning whatsoever from these terms. No, it is not intuitive.
Please define these terms in whole, detailed sentences.
Also note that the file /documentation/how_to_configure_options.txt suggests to read through the file default.cfg without mentioning WHERE the file can be found.
# The span for aligning struct/union member definitions.
#
# 0: Don't align (default).
align_var_struct_span = 0 # unsigned number
# The threshold for aligning struct/union member definitions.
# Use a negative number for absolute thresholds.
#
# 0: No limit (default).
align_var_struct_thresh = 0 # number
# The gap for aligning struct/union member definitions.
align_var_struct_gap = 0 # unsigned number