Commit 937190d3 authored by jon@gigan's avatar jon@gigan

For generated NDB documentation:

Some grammar/spelling fixes in mgmapi.h; 
also some tests of formatting commands.
parent f8d84af4
...@@ -22,27 +22,26 @@ ...@@ -22,27 +22,26 @@
* *
* The NDB Cluster Management API (MGM API) is a C API * The NDB Cluster Management API (MGM API) is a C API
* that is used to: * that is used to:
* - Start/stop database nodes (DB nodes) * - Start and stop database nodes (DB nodes)
* - Start/stop NDB Cluster backups * - Start and stop NDB Cluster backups
* - Control the NDB Cluster log * - Control the NDB Cluster log
* - Other administrative tasks * - Perform other administrative tasks
* *
* @section General Concepts * @section General Concepts
* *
* Each MGM API function needs a management server handle * Each MGM API function needs a management server handle
* (of type Mgm_C_Api::NdbMgmHandle). * of type <code>Mgm_C_Api::NdbMgmHandle</code>.
* This handle is initally is created by calling the * This handle is initally created by calling the
* function ndb_mgm_create_handle(). * function <code>ndb_mgm_create_handle()</code>.
* *
* A function can return: * A function can return:
* -# An integer value. * -# An integer value.
* If it returns -1 then this indicates an error, and then * A value of <b>-1</b> indicates an error.
* -# A pointer value. If it returns NULL then check the latest error. * -# A pointer value. A <var>NULL</var> value indicates an error;
* If it didn't return NULL, then a "something" is returned. * Otherwise, the return value must be <code>free()</code>ed by the user of the MGM API.
* This "something" has to be free:ed by the user of the MGM API.
* *
* If there are an error, then the get latest error functions * Error conditions can be identified by using the appropriate
* can be used to check what the error was. * error-reporting functions.
*/ */
/** @addtogroup MGM_C_API /** @addtogroup MGM_C_API
...@@ -194,7 +193,7 @@ extern "C" { ...@@ -194,7 +193,7 @@ extern "C" {
int node_group; /*< Node group of node int node_group; /*< Node group of node
*< (only valid for DB nodes)*/ *< (only valid for DB nodes)*/
int version; /*< Internal version number*/ int version; /*< Internal version number*/
int connect_count; /*< No of times node has connected int connect_count; /*< Number of times node has connected
*< or disconnected to the mgm srv *< or disconnected to the mgm srv
*/ */
char connect_address[sizeof("000.000.000.000")+1]; char connect_address[sizeof("000.000.000.000")+1];
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment