Commit 73d2a1f7 authored by Greg Williams's avatar Greg Williams
Browse files

Updated Doxygen docs

parent 4a781be7

config/Doxyfile

+1 −1
Original line number Diff line number Diff line
@@ -38,7 +38,7 @@ PROJECT_NAME = protobuf-c 
# could be handy for archiving the generated documentation or if some version

# control system is used.



PROJECT_NUMBER           = "v0.6.0"

PROJECT_NUMBER           = "v0.7.0"



# Using the PROJECT_BRIEF tag one can provide an optional one line description

# for a project that appears at the top of each page and should give viewer a

include/kinetic_client.h

+8 −8
Original line number Diff line number Diff line
@@ -34,14 +34,14 @@ void KineticClient_Init(const char* logFile); 
 * @brief Initializes the Kinetic API, configures logging destination, establishes a

 * connection to the specified Kinetic Device, and establishes a session.

 *

 * @config          Session configuration

 * @param config    Session configuration

 *  .host             Host name or IP address to connect to

 *  .port             Port to establish socket connection on

 *  .nonBlocking      Set to true for non-blocking or false for blocking I/O

 *  .clusterVersion   Cluster version to use for the session

 *  .identity         Identity to use for the session

 *  .hmacKey          Key to use for HMAC calculations (NULL-terminated string)

 * @handle          Pointer to KineticSessionHandle (populated upon successful connection)

 * @param handle    Pointer to KineticSessionHandle (populated upon successful connection)

 *

 * @return          Returns the resulting KineticStatus

 */