Add route table guide and formatting tweaks

[ric-plt/lib/rmr.git] / docs / rmr_get_meid.3.rst

diff --git a/docs/rmr_get_meid.3.rst b/docs/rmr_get_meid.3.rst
index b80faf0..d97cfd9 100644 (file)
--- a/docs/rmr_get_meid.3.rst
+++ b/docs/rmr_get_meid.3.rst
@@ -1,79 +1,88 @@
- 
- 
 .. This work is licensed under a Creative Commons Attribution 4.0 International License. 
 .. SPDX-License-Identifier: CC-BY-4.0 
 .. CAUTION: this document is generated from source in doc/src/rtd. 
 .. To make changes edit the source and recompile the document. 
 .. Do NOT make changes directly to .rst or .md files. 
  
- 
 ============================================================================================ 
 Man Page: rmr_get_meid 
 ============================================================================================ 
  
-RMR Library Functions 
-============================================================================================ 
- 
- 
-NAME 
--------------------------------------------------------------------------------------------- 
  
+
+
+RMR LIBRARY FUNCTIONS
+=====================
+
+
+
+NAME
+----
+
 rmr_get_meid 
- 
-SYNOPSIS 
--------------------------------------------------------------------------------------------- 
- 
+
+
+SYNOPSIS
+--------
+
  
 :: 
-  
+ 
  #include <rmr/rmr.h>
+  
  char* rmr_get_meid( rmr_mbuf_t* mbuf, unsigned char* dest )
  
- 
- 
-DESCRIPTION 
--------------------------------------------------------------------------------------------- 
- 
-The rmr_get_meid function will copy the managed entity ID 
+
+
+DESCRIPTION
+-----------
+
+The ``rmr_get_meid`` function will copy the managed entity ID 
 (meid) field from the message into the *dest* buffer provided 
 by the user. The buffer referenced by *dest* is assumed to be 
-at least RMR_MAX_MEID bytes in length. If *dest* is NULL, 
+at least ``RMR_MAX_MEID`` bytes in length. If *dest* is NULL, 
 then a buffer is allocated (the calling application is 
 expected to free when the buffer is no longer needed). 
- 
-RETURN VALUE 
--------------------------------------------------------------------------------------------- 
- 
+
+
+RETURN VALUE
+------------
+
 On success, a pointer to the extracted string is returned. If 
 *dest* was supplied, then this is just a pointer to the 
 caller's buffer. If *dest* was NULL, this is a pointer to the 
 allocated buffer. If an error occurs, a nil pointer is 
 returned and errno is set as described below. 
- 
-ERRORS 
--------------------------------------------------------------------------------------------- 
- 
-If an error occurs, the value of the global variable errno 
-will be set to one of the following with the indicated 
-meaning. 
- 
- 
- 
-EINVAL 
-   
-  The message, or an internal portion of the message, was 
-  corrupted or the pointer was invalid. 
-   
- 
-ENOMEM 
-   
-  A nil pointer was passed for *dest,* however it was not 
-  possible to allocate a buffer using malloc(). 
- 
- 
-SEE ALSO 
--------------------------------------------------------------------------------------------- 
- 
+
+
+ERRORS
+------
+
+If an error occurs, the value of the global variable 
+``errno`` will be set to one of the following with the 
+indicated meaning. 
+ 
+   .. list-table:: 
+     :widths: auto 
+     :header-rows: 0 
+     :class: borderless 
+      
+     * - **EINVAL** 
+       - 
+         The message, or an internal portion of the message, was 
+         corrupted or the pointer was invalid. 
+      
+     * - **ENOMEM** 
+       - 
+         A nil pointer was passed for *dest,* however it was not 
+         possible to allocate a buffer using malloc(). 
+          
+ 
+
+
+SEE ALSO
+--------
+
 rmr_alloc_msg(3), rmr_bytes2xact(3), rmr_bytes2meid(3), 
 rmr_call(3), rmr_free_msg(3), rmr_get_rcvfd(3), 
 rmr_get_xact(3), rmr_payload_size(3), rmr_send_msg(3),