Improved doxygen descriptions (db9e4898) · Commits · Matteo Quintiliani / nmxptool

include/nmxp.h

+6 −4

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@
		* Istituto Nazionale di Geofisica e Vulcanologia - Italy
		* quintiliani@ingv.it
		*
		* $Id: nmxp.h,v 1.44 2007-12-28 10:37:28 mtheo Exp $
		* $Id: nmxp.h,v 1.45 2008-03-11 07:28:55 mtheo Exp $
		*
		*/

		@@ -1163,11 +1163,13 @@ NMXP_CHAN_LIST nmxp_getAvailableChannelList(char hostname, int portnum, NMXP_

		/*! \brief Get the list of the start and end time for the available data for each channel.
		*
		* \param hostname host name
		* \param portnum port number
		* \param hostname host name.
		* \param portnum port number.
		* \param datatype Type of data contained in the channel.
		* \param datas_username DataServer user name.
		* \param datas_password DataServer password.
		* \param flag_request_channelinfo Request information about Network.
		* \param[out] channelList pointer to channel list
		* \param[out] pchannelList pointer to a pointer of channel list.
		*
		* \return Channel list. It will need to be freed.
		*

+3 −3

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@
		* Istituto Nazionale di Geofisica e Vulcanologia - Italy
		* quintiliani@ingv.it
		*
		* $Id: nmxp_base.h,v 1.27 2008-01-18 06:46:38 mtheo Exp $
		* $Id: nmxp_base.h,v 1.28 2008-03-11 07:28:55 mtheo Exp $
		*
		*/

		@@ -146,7 +146,7 @@ int nmxp_receiveMessage(int isock, NMXP_MSG_SERVER type, void *buffer, int32_t
		* \param buffer_data Pointer to the data buffer containing Compressed Nanometrics packets.
		* \param length_data Buffer length in bytes.
		* \param channelList Pointer to the Channel List.
		* \param network_code Network code. It can be NULL.
		* \param network_code_default Value of network code to assign returned structure. It should not be NULL.
		*
		* \return Return a pointer to static struct NMXP_DATA_PROCESS.
		*
		@@ -159,7 +159,7 @@ NMXP_DATA_PROCESS nmxp_processCompressedData(char buffer_data, int length_data
		* \param buffer_data Pointer to the data buffer containing Decompressed Nanometrics packets.
		* \param length_data Buffer length in bytes.
		* \param channelList Pointer to the Channel List.
		* \param network_code Network code. It can be NULL.
		* \param network_code_default Value of network code to assign returned structure. It should not be NULL.
		*
		* \return Return a pointer to static struct NMXP_DATA_PROCESS.
		*

+3 −2

Original line number	Diff line number	Diff line
		@@ -7,7 +7,7 @@
		* Istituto Nazionale di Geofisica e Vulcanologia - Italy
		* quintiliani@ingv.it
		*
		* $Id: nmxp_win.h,v 1.2 2008-02-19 14:40:20 mtheo Exp $
		* $Id: nmxp_win.h,v 1.3 2008-03-11 07:28:55 mtheo Exp $
		*
		*/

		@@ -26,13 +26,14 @@
		void nmxp_initWinsock();

		/*! \brief A function similar in spirit to Unix's perror().
		*
		* This function returns a pointer to an internal static buffer, so you must
		* copy the data from this function before you call it again. It follows that
		* this function is also not thread-safe.
		*
		* \param nErrorID
		*
		* \retval
		* \return Return a pointer to a static string which contains error description.
		*
		*/
		char* WSAGetLastErrorMessage(int nErrorID);