dma_heap_find(), dma_heap_buffer_alloc() and dma_heap_bufferfd_alloc() all
have a documented parameter list but no Return: section, so kernel-doc has
nothing to say about what a caller gets back.
Documentation/doc-guide/kernel-doc.rst asks for a Return: section on
functions that return a value, and scripts/kernel-doc -none -Wall
include/linux/dma-heap.h reports three "No description found for return
value" warnings before this change and none after it. The default warning
level is unaffected: the file is clean there both before and after.
The wording follows what the implementations in drivers/dma-buf/dma-heap.c
actually do:
dma_heap_find() returns the heap, or NULL when the name is not
registered
dma_heap_buffer_alloc() returns a dma_buf, or an ERR_PTR() on failure
dma_heap_bufferfd_alloc() returns an fd, or a negative errno on failure
All three helpers are ANDROID-only and do not exist upstream, so there is
nothing to send to mainline for this.
No functional change.
Change-Id: I9b8aa342cdda421af018171ec96f1257d8dbd5bc
Signed-off-by: Hung-Chun Tseng <alan.tseng.cs@gmail.com>
Hung-Chun Tseng
ff645d863b