From 1866deb06d775b9d006c1ef21c99f439677f0f76 Mon Sep 17 00:00:00 2001 From: Evan Benn Date: Thu, 28 Apr 2022 12:36:53 +1000 Subject: libflashrom: Move documentation to header The doxygen documentation was in the libflashrom.c file. Move the documentation to the libflashrom.h file. This allows foreign function interface binding generators (eg rust bindgen) that operate on the .h file to generate documentation for the target language. Some doxygen errors were also corrected, mostly undocumented or wrongly labeled parameters. To test, I have diffed and inspected the doxygen documentation before and after the change. All functions are documented the same, and the structs and enums are now also included in the docs. Change-Id: I856b74d5bfea13722539be15496755a95e701eea Signed-off-by: Evan Benn Reviewed-on: https://review.coreboot.org/c/flashrom/+/63903 Tested-by: build bot (Jenkins) Reviewed-by: Angel Pons Reviewed-by: Edward O'Callaghan Reviewed-by: Felix Singer --- writeprotect.c | 2 -- 1 file changed, 2 deletions(-) (limited to 'writeprotect.c') diff --git a/writeprotect.c b/writeprotect.c index ab6b1761..cfdd15b8 100644 --- a/writeprotect.c +++ b/writeprotect.c @@ -489,5 +489,3 @@ out: free(range_pairs); return ret; } - -/** @} */ /* end flashrom-wp */ -- cgit v1.2.3