diff options
| author | Bob Beck <[email protected]> | 2026-06-12 17:55:42 +0200 |
|---|---|---|
| committer | Neil Horman <[email protected]> | 2026-07-10 17:37:03 +0200 |
| commit | c17828595f60ab0a91c54a8da7c3461387ea77a7 (patch) | |
| tree | bb6be1094aa3773dd4aa94547435644a726bb3ab /STYLE.md | |
| parent | Modernize and update STYLE.MD, add DOCUMENTATION.MD (diff) | |
| download | openssl-c17828595f60ab0a91c54a8da7c3461387ea77a7.tar.gz openssl-c17828595f60ab0a91c54a8da7c3461387ea77a7.zip | |
Change the Doxygen doc requirement for non public functions
To be at the prototype site in the internal header file.
The major reason *Why* we would like to have Doxygen style comments
describing what internals do is so that they work with modern IDE's
since most common ones support them.
It's wonderful to be looking at an internal function, thinking "wtf is this",
and be able to hover over it and - boink - up comes the docs. This
typically only works (or works better) when the Doxygen comment is
at the prototype site, not if it is at the implementation site.
This also reinforces the requirement that "yes you do this for shared
functions but you don't need to for statics".
Reviewed-by: Neil Horman <[email protected]>
Reviewed-by: Milan Broz <[email protected]>
MergeDate: Fri Jul 10 15:37:18 2026
(Merged from https://github.com/openssl/openssl/pull/29295)
Diffstat (limited to 'STYLE.md')
| -rw-r--r-- | STYLE.md | 5 |
1 files changed, 1 insertions, 4 deletions
@@ -314,10 +314,7 @@ typedef struct foo_st { * @param b input integer to add * @returns the sum of a and b */ -int add(int a, int b) -{ - return a + b; -} +int add(int a, int b); ``` #### Spec-mirroring variables |
