3 Commits

Author	SHA1	Message	Date
Evan Benn	1866deb06d	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 <evanbenn@chromium.org> Reviewed-on: https://review.coreboot.org/c/flashrom/+/63903 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Angel Pons <th3fanbus@gmail.com> Reviewed-by: Edward O'Callaghan <quasisec@chromium.org> Reviewed-by: Felix Singer <felixsinger@posteo.net>	2022-05-06 01:00:37 +00:00
Nico Huber	4f213285d7	layout: Move generic layout functions into layout.c ... Change-Id: If1edde70fc51e88e6e1c560d79a0d51941b9627c Signed-off-by: Nico Huber <nico.h@gmx.de> Reviewed-on: https://review.coreboot.org/c/flashrom/+/33514 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Arthur Heymans <arthur@aheymans.xyz>	2019-06-17 08:31:18 +00:00
Nico Huber	a9fc4f4ebf	Add Doxyfile for libflashrom documentation ... Reference documentation for libflashrom can be build with doxygen. With doxygen Doxyfile documentation will be put into a libflashrom-doc/ subdirectory. v2: o Updated Doxyfile with `doxygen -u Doxyfile`. o Added flashrom.c to the INPUT list. Change-Id: I583bf9aa8c43049723aff498625d490c37832f13 Signed-off-by: Nico Huber <nico.huber@secunet.com> Reviewed-on: https://review.coreboot.org/17947 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: David Hendricks <david.hendricks@gmail.com>	2017-06-03 20:13:31 +02:00