[openssl-dev] [openssl.org #4343] master: EC_KEY_priv2buf (): check parameter sanity
Viktor Dukhovni
openssl-users at dukhovni.org
Fri Feb 26 17:42:02 UTC 2016
On Fri, Feb 26, 2016 at 12:37:22PM -0500, Jeffrey Walton wrote:
> It seems like (to me) the the most direct way to mark a function as
> private is to add a comment in the source code stating such.
Nonsense. Source code is not API documentation, it is an
implementation, not an interface contract.
> That will avoid pain points for public but undocumented functions.
There's must (as soon as we can get there) be no such thing as a
"public, but undocumented" function.
> it also seems like (to me) that tying bug fixes to documentation is a bad idea.
Bug fixes to undocumented functions will be buggy, and the
documentation will never happen. We need to improve code quality,
a good part of that is having documentation.
--
Viktor.
More information about the openssl-dev
mailing list