Attention is currently required from: Edward O'Callaghan, Angel Pons, Anastasia Klimchuk, Peter Marheine. Evan Benn has posted comments on this change. ( https://review.coreboot.org/c/flashrom/+/63903 )
Change subject: libflashrom: Move documentation to header ......................................................................
Patch Set 7:
(9 comments)
This change is ready for review.
Commit Message:
https://review.coreboot.org/c/flashrom/+/63903/comment/21547ca9_5426a705 PS6, Line 10: FFI
What's this?
Done
https://review.coreboot.org/c/flashrom/+/63903/comment/9e1bab3c_44d0ed61 PS6, Line 16: and after the change.
And what's the result of the test?
Done
File include/libflashrom.h:
https://review.coreboot.org/c/flashrom/+/63903/comment/7478bcee_d8edf16c PS6, Line 65: file
a file […]
Done
https://review.coreboot.org/c/flashrom/+/63903/comment/d52d059b_57c48168 PS6, Line 262: short
small
Done
https://review.coreboot.org/c/flashrom/+/63903/comment/c68cf0eb_13506e9a PS6, Line 356: buffer
a buffer
Done
https://review.coreboot.org/c/flashrom/+/63903/comment/7c8052fa_778e3722 PS6, Line 372: another
I'd use `a` to be more precise, as `flashrom_layout_new()` returns layouts with no regions.
I am happy to make these edits, I'm just checking that you know I am moving these lines from one place to another.
https://review.coreboot.org/c/flashrom/+/63903/comment/6f2dc4d3_c5057d5c PS6, Line 398: * @param start The start address to be written. : * @param len The length of the region to be written.
Maybe @param[out] ?
Done
https://review.coreboot.org/c/flashrom/+/63903/comment/e344e552_9934e423 PS6, Line 416: he
I'd avoid using personal pronouns in documentation, the caller isn't necessarily a "he". How about: […]
Done
https://review.coreboot.org/c/flashrom/+/63903/comment/6380a44a_d4c10a61 PS6, Line 463: [out]
Why is this an out parameter?
Done