Commit fd920a59 authored by Matteo Quintiliani's avatar Matteo Quintiliani

added some documentation


git-svn-id: file:///home/quintiliani/svncopy/nmxptool/trunk@1237 3cd66e75-5955-46cb-a940-c26e5fc5497d
parent 01d9e0ea
......@@ -7,7 +7,7 @@
* Istituto Nazionale di Geofisica e Vulcanologia - Italy
* quintiliani@ingv.it
*
* $Id: nmxp.h,v 1.53 2009-03-10 16:36:25 mtheo Exp $
* $Id: nmxp.h,v 1.54 2009-03-11 16:34:08 mtheo Exp $
*
*/
......@@ -15,7 +15,7 @@
*
* <center>
* Matteo Quintiliani
*
*
* <i>
* Istituto Nazionale di Geofisica e Vulcanologia<br />
* Centro Nazionale Terremoti
......@@ -1159,6 +1159,7 @@ int nmxp_sendDataRequest(int isock, int32_t key, int32_t start_time, int32_t end
* \param hostname host name
* \param portnum port number
* \param datatype Type of data contained in the channel.
* \param func_cond Pointer to function for exit condition from loop.
*
* \return Channel list. It will need to be freed.
*
......@@ -1177,6 +1178,7 @@ NMXP_CHAN_LIST *nmxp_getAvailableChannelList(char * hostname, int portnum, NMXP_
* \param datas_password DataServer password.
* \param flag_request_channelinfo Request information about Network.
* \param[out] pchannelList pointer to a pointer of channel list.
* \param func_cond Pointer to function for exit condition from loop.
*
* \return Channel list. It will need to be freed.
*
......
......@@ -7,7 +7,7 @@
* Istituto Nazionale di Geofisica e Vulcanologia - Italy
* quintiliani@ingv.it
*
* $Id: nmxp_base.h,v 1.32 2008-04-22 12:53:42 mtheo Exp $
* $Id: nmxp_base.h,v 1.33 2009-03-11 16:34:08 mtheo Exp $
*
*/
......@@ -32,6 +32,7 @@
*
* \param hostname hostname
* \param portNum port number
* \param func_cond Pointer to function for exit condition from loop.
*
* \retval sd A descriptor referencing the socket.
* \retval -1 "Empty host name", "Cannot lookup host", ...
......@@ -202,7 +203,7 @@ unsigned int nmxp_sleep(unsigned int sleep_time);
* \retval ....
*
*/
unsigned int nmxp_usleep(unsigned int sleep_time);
unsigned int nmxp_usleep(unsigned int usleep_time);
#endif
......@@ -7,7 +7,7 @@
* Istituto Nazionale di Geofisica e Vulcanologia - Italy
* quintiliani@ingv.it
*
* $Id: nmxp_data.h,v 1.33 2009-03-11 06:06:57 mtheo Exp $
* $Id: nmxp_data.h,v 1.34 2009-03-11 16:34:08 mtheo Exp $
*
*/
......@@ -283,6 +283,9 @@ int nmxp_data_mkdirp(const char *filename);
/*! \brief Initialize a structure NMXP_DATA_SEED
*
* \param data_seed Pointer to a NMXP_DATA_SEED structure.
* \param default_network String containing default network code.
* \param outdirseed Root output directory for SDS or BUD structure.
* \param type_writeseed Declare SDS or BUD structure.
*
*/
int nmxp_data_seed_init(NMXP_DATA_SEED *data_seed, char *default_network, char *outdirseed, NMXP_DATA_SEED_TYPEWRITE type_writeseed);
......@@ -290,7 +293,8 @@ int nmxp_data_seed_init(NMXP_DATA_SEED *data_seed, char *default_network, char *
/*! \brief Open file in a structure NMXP_DATA_SEED, in case close file before.
*
* \param data_seed Pointer to a NMXP_DATA_SEED structure.
* \param possible argument is pd
*
* N.B. nmxp_data_seed_fopen() reads information from data_seed->pd.
*
*/
int nmxp_data_seed_fopen(NMXP_DATA_SEED *data_seed);
......@@ -298,6 +302,7 @@ int nmxp_data_seed_fopen(NMXP_DATA_SEED *data_seed);
/*! \brief Close file in a structure NMXP_DATA_SEED
*
* \param data_seed Pointer to a NMXP_DATA_SEED structure.
* \param i Index of the file descriptor to delete.
*
*/
int nmxp_data_seed_fclose(NMXP_DATA_SEED *data_seed, int i);
......
......@@ -24,8 +24,6 @@
/*! \brief
*
* \param
* \param
*
*/
inline int nmxp_mem_null_function();
......
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