summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
author Quddus Chong <quddusc@google.com> 2017-05-09 10:39:23 -0700
committer Quddus Chong <quddusc@google.com> 2017-05-09 11:03:06 -0700
commit5163357fc094cefaf08c6d50a933fdfee13ab76d (patch)
tree6b6a41c17137b900f88a1131752fcccb57629f71 /include
parent007b00e775b92025d539eac69b93b7eb91164db1 (diff)
docs: Fixed doc comments to enable Doxygen to generate code block correctly.
Test: Verified by manually generating docs. Change-Id: Id79a77e71deb26e0dd5d22843c2f09d9000e587d
Diffstat (limited to 'include')
-rw-r--r--include/android/sharedmem.h19
1 files changed, 9 insertions, 10 deletions
diff --git a/include/android/sharedmem.h b/include/android/sharedmem.h
index 8f8a9314c2..46d2f4bf4a 100644
--- a/include/android/sharedmem.h
+++ b/include/android/sharedmem.h
@@ -86,21 +86,20 @@ 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.
- * char *buffer = (char *) mmap(NULL, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
+ * int fd = ASharedMemory_create("memory", 128);
*
- * strcpy(buffer, "This is an example."); // trivially initialize content
+ * // By default it has PROT_READ | PROT_WRITE | PROT_EXEC.
+ * char *buffer = (char *) mmap(NULL, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
*
- * // limit access to read only
- * ASharedMemory_setProt(fd, PROT_READ);
+ * strcpy(buffer, "This is an example."); // trivially initialize content
*
- * // share fd with another process here and the other process can only map with PROT_READ.
- * \endcode
+ * // limit access to read only
+ * ASharedMemory_setProt(fd, PROT_READ);
+ *
+ * // share fd with another process here and the other process can only map with PROT_READ.
*
* \param fd file descriptor of the shared memory region.
* \param prot any bitwise-or'ed combination of PROT_READ, PROT_WRITE, PROT_EXEC denoting