Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5163357f authored by Quddus Chong's avatar Quddus Chong
Browse files

docs: Fixed doc comments to enable Doxygen to generate code block correctly. 

Test: Verified by manually generating docs.

Change-Id: Id79a77e71deb26e0dd5d22843c2f09d9000e587d
parent 007b00e7

include/android/sharedmem.h

+9 −10
Original line number Diff line number Diff line
@@ -86,9 +86,9 @@ size_t ASharedMemory_getSize(int fd); 
 *

 * It is a common use case to create a shared memory region, map it read/write locally to intialize

 * content, and then send the shared memory to another process with read only access. Code example

 * as below (error handling ommited).

 * as below (error handling omited).

 *

 *

 * \code{.c}

 *     int fd = ASharedMemory_create("memory", 128);

 *

 *     // By default it has PROT_READ | PROT_WRITE | PROT_EXEC.
@@ -100,7 +100,6 @@ size_t ASharedMemory_getSize(int fd); 
 *     ASharedMemory_setProt(fd, PROT_READ);

 *

 *     // share fd with another process here and the other process can only map with PROT_READ.

 * \endcode

 *

 * \param fd   file descriptor of the shared memory region.

 * \param prot any bitwise-or'ed combination of PROT_READ, PROT_WRITE, PROT_EXEC denoting