mirror of
https://github.com/github/codeql.git
synced 2026-03-28 02:08:17 +01:00
It superficially looks like `@param` is supported in QLDoc, but this is mostly an accident of how its parser works. Attributes starting with `@` are only intended to be used in the top-level QLDoc of a query, and there can only be one of each attribute. If there are multiple `@param` entries, the QLDoc parser will only keep the first one. Even though `parseConvSpec` in `Scanf.qll` documented multiple parameters, only the first one would be shown in an IDE. The corresponding predicate in `Print.qll` documented only its first parameter, perhaps because of an autoformatting accident earlier in time. I've attempted to reconstruct documentation for its other parameters based on its sibling in `Scanf.qll`.