-
Notifications
You must be signed in to change notification settings - Fork 2.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Doxygen file blocks to remove copyright and license information #1283
Update Doxygen file blocks to remove copyright and license information #1283
Conversation
40e03a1
to
47789d1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I checked all the headers in the /include directory and I can confirm the Doxygen blocks are separated from the copyright notices.
I have noticed that this is not true for the doxygen/input files, but I'm not sure if that is even an issue and it reaches beyond the scope of this PR. So I'm just leaving this comment.
FYI it's important to check On the other hand, |
@k-stachowiak @Patater Indeed the files in
It would be best to update the sample configurations in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everything that has been done, looks good (removed copyright from Doxygen output, kept it in the source files, and no other changed).
I sampled the rendered HTML of scripts/config.pl full && make apidoc
, and I also sampled the diff between the corresponding output before and after the patch.
However, as noted, this is incomplete. Please update the files in configs/
and in doxygen/input/
as well.
Remove the copyright block from the Doxygen comments, to clean up the detailed description in the generated Doxygen output. Also, add \file and \brief tags to all headers in doxygen/input.
47789d1
to
25facdd
Compare
The files in All previously mentioned testing performed by me has been redone, with the exception of running |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It all looks good now.
|
CI failure is FreeBSD timing test
|
…estricted-20240823 Merge 2.28 into -restricted
This PR separates the copyright and license information from the Doxygen documentation blocks. The documentation was also updated to have file and brief blocks for all header files in
include/mbedtls/
.Work done by @dgreen-arm
Testing done: