doc: services: storage: add flash_img section #45520
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martinjaeger
requested review from
MaureenHelm,
carlescufi,
galak and
nashif
as code owners
Member
Author
|
Looks like the doc build fails because there is a @carlescufi or @gmarull do you have any idea how to fix this without changing the API? |
martinjaeger
force-pushed
the
doc-flash-img
branch
from
451cd59 to
6bd2ce8
Compare
gmarull
previously approved these changes
May 11, 2022
Doxygen comments were existing, but they were not rendered anywhere in the docs. The code is located under DFU, but I think it makes sense to document it under storage, next to similar flash-related APIs. Signed-off-by: Martin Jäger <[email protected]>
martinjaeger
force-pushed
the
doc-flash-img
branch
from
6bd2ce8 to
370a52b
Compare
Member
Author
|
Thanks @gmarull for pointing me the right location in the docs. It's working now. Unfortunately I had a mistake in the regex in the first attempt, so I have to ask you to re-approve. |
gmarull
approved these changes
May 11, 2022
mbolivar-nordic
approved these changes
May 13, 2022
Contributor
mbolivar-nordic
left a comment
mbolivar-nordic
left a comment
There was a problem hiding this comment.
LGTM. Will wait for @carlescufi to ACK as the assignee; since this is a docs patch, it can come in after code freeze.
de-nordic
approved these changes
May 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Doxygen comments were existing, but they were not rendered anywhere in the docs.
The code is located in the DFU subsystem, but I think it makes sense to document it under storage, next to similar flash-related APIs.