Attention is currently required from: Evan Benn.

Evan Benn uploaded patch set #8 to this change.

View Change

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>
---
M Doxyfile
M flashrom.c
M include/libflashrom.h
M layout.c
M libflashrom.c
M writeprotect.c
6 files changed, 440 insertions(+), 473 deletions(-)

git pull ssh://review.coreboot.org:29418/flashrom refs/changes/03/63903/8

To view, visit change 63903. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-Project: flashrom
Gerrit-Branch: master
Gerrit-Change-Id: I856b74d5bfea13722539be15496755a95e701eea
Gerrit-Change-Number: 63903
Gerrit-PatchSet: 8
Gerrit-Owner: Evan Benn <evanbenn@google.com>
Gerrit-Reviewer: Anastasia Klimchuk <aklm@chromium.org>
Gerrit-Reviewer: Angel Pons <th3fanbus@gmail.com>
Gerrit-Reviewer: Edward O'Callaghan <quasisec@chromium.org>
Gerrit-Reviewer: Peter Marheine <pmarheine@chromium.org>
Gerrit-Reviewer: build bot (Jenkins) <no-reply@coreboot.org>
Gerrit-CC: Paul Menzel <paulepanter@mailbox.org>
Gerrit-Attention: Evan Benn <evanbenn@google.com>
Gerrit-MessageType: newpatchset