From e468b45230dcf71e20f9df16afab5eb7a75f09cd Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jan=20Posp=C3=AD=C5=A1il?= Date: Mon, 17 Jan 2005 11:40:09 +0000 Subject: [PATCH] Documentation update. --- org.glite.lb.client-interface/interface/consumer.h | 65 ++++++++++----------- org.glite.lb.client-interface/interface/context.h | 10 +++- org.glite.lb.client-interface/interface/events.h.T | 8 +-- .../interface/jobstat.h.T | 2 +- .../interface/producer.h.T | 67 ++++++++++++---------- .../project/configure.properties.xml | 29 ++++++---- 6 files changed, 101 insertions(+), 80 deletions(-) diff --git a/org.glite.lb.client-interface/interface/consumer.h b/org.glite.lb.client-interface/interface/consumer.h index 5a8cf96..1284b90 100644 --- a/org.glite.lb.client-interface/interface/consumer.h +++ b/org.glite.lb.client-interface/interface/consumer.h @@ -2,7 +2,7 @@ #define __EDG_WORKLOAD_LOGGING_CLIENT_CONSUMER_H__ /*! - * \file client/consumer.h (lbapi.h originaly) + * \file consumer.h * \brief L&B consumer API * * General rules: @@ -131,10 +131,10 @@ extern int set_server_name_and_port( * \a attr \a op \a value eg. time > 87654321. * \see edg_wll_QueryRec * - * \param context IN: context to work with - * \param job_conditions IN: query conditions (ANDed) on current job status, null (i.e. ATTR_UNDEF) terminated list. NULL means empty list, i.e. always TRUE - * \param event_conditions: conditions on events, null terminated list, NULL means empty list, i.e. always TRUE - * \param events OUT: list of matching events + * \param context IN: context to work with + * \param job_conditions IN: query conditions (ANDed) on current job status, null (i.e. ATTR_UNDEF) terminated list. NULL means empty list, i.e. always TRUE + * \param event_conditions: IN: conditions on events, null terminated list, NULL means empty list, i.e. always TRUE + * \param events OUT: list of matching events */ int edg_wll_QueryEvents( edg_wll_Context context, @@ -173,11 +173,11 @@ int edg_wll_QueryEventsExtProxy( * Return jobs (and possibly their states) for which an event satisfying the conditions * exists. * \see edg_wll_QueryEvents - * \param context IN: context to work with - * \param conditions IN: query records (ANDed), null (i.e. EDG_WLL_ATTR_UNDEF) terminated list - * \param flags IN: additional status fields to retrieve (\see edg_wll_JobStatus) - * \param jobs OUT: list of job ids. May be NULL. - * \param states OUT: list of corresponding states (returned only if not NULL) + * \param context IN: context to work with + * \param conditions IN: query records (ANDed), null (i.e. EDG_WLL_ATTR_UNDEF) terminated list + * \param flags IN: additional status fields to retrieve (\see edg_wll_JobStatus) + * \param jobs OUT: list of job ids. May be NULL. + * \param states OUT: list of corresponding states (returned only if not NULL) */ int edg_wll_QueryJobs( edg_wll_Context context, @@ -227,10 +227,11 @@ int edg_wll_QueryJobsExtProxy( /* starting from bit 10 private flags begins - do not add 1024 and more! */ /** Return status of a single job. - * \param context IN: context to operate on - * \param jobid IN: query this job - * \param flags IN: specifies optional status fields to retrieve, + * \param context IN: context to operate on + * \param jobid IN: query this job + * \param flags IN: specifies optional status fields to retrieve, * \see EDG_WLL_STAT_CLASSADS, EDG_WLL_STAT_CHILDREN, EDG_WLL_STAT_CHILDSTAT + * \param status OUT: status */ int edg_wll_JobStatus( @@ -253,9 +254,9 @@ int edg_wll_JobStatusProxy( /** * Return all events related to a single job. * Convenience wrapper around edg_wll_Query() - * \param context IN: context to work with - * \param jobId IN: job to query - * \param events OUT: list of events + * \param context IN: context to work with + * \param jobId IN: job to query + * \param events OUT: list of events */ int edg_wll_JobLog( @@ -276,9 +277,9 @@ int edg_wll_JobLogProxy( /** * All current user's jobs. - * \param context IN: context to work with - * \param jobs OUT: list of the user's jobs - * \param states OUT: list of the jobs' states + * \param context IN: context to work with + * \param jobs OUT: list of the user's jobs + * \param states OUT: list of the jobs' states */ int edg_wll_UserJobs( edg_wll_Context context, @@ -299,8 +300,8 @@ int edg_wll_UserJobsProxy( /** * Server supported indexed attributes * \see DataGrid-01-TEN-0125 - * \param context IN: context to work with - * \param attrs OUT: configured indices (each index is an UNDEF-terminated + * \param context IN: context to work with + * \param attrs OUT: configured indices (each index is an UNDEF-terminated * array of QueryRec's from which only attr (and attr_id * eventually) are meaningful */ @@ -313,8 +314,8 @@ int edg_wll_GetIndexedAttrs( * Retrieve limit on query result size (no. of events or jobs). * FIXME: not implemented. * \see DataGrid-01-TEN-0125 - * \param context IN: context to work with - * \param limit OUT: server imposed limit + * \param context IN: context to work with + * \param limit OUT: server imposed limit */ int edg_wll_GetServerLimit( edg_wll_Context context, @@ -323,11 +324,11 @@ int edg_wll_GetServerLimit( /** * UI port for the job - * \param context IN: context to work with - * \param jobId IN: job to query - * \param name IN: name of the UI-port - * \param host OUT: hostname of port - * \param port OUT: port number + * \param context IN: context to work with + * \param jobId IN: job to query + * \param name IN: name of the UI-port + * \param host OUT: hostname of port + * \param port OUT: port number */ int edg_wll_QueryListener( edg_wll_Context context, @@ -341,7 +342,7 @@ int edg_wll_QueryListener( /** * Query LBProxy and use plain communication */ -int edg_wll_QueryListener( +int edg_wll_QueryListenerProxy( edg_wll_Context context, edg_wlc_JobId jobId, const char * name, @@ -351,9 +352,9 @@ int edg_wll_QueryListener( /** * Ask LB Proxy server for sequence number - * \param context IN: context to work with - * \param jobId IN: job to query - * \param code OUT: sequence code + * \param context IN: context to work with + * \param jobId IN: job to query + * \param code OUT: sequence code */ diff --git a/org.glite.lb.client-interface/interface/context.h b/org.glite.lb.client-interface/interface/context.h index 5f176d5..c22e713 100644 --- a/org.glite.lb.client-interface/interface/context.h +++ b/org.glite.lb.client-interface/interface/context.h @@ -2,7 +2,7 @@ #define _EDG_WORKLOAD_LOGGING_CLIENT_CONTEXT_H /** - * \file edg/workload/logging/client/context.h + * \file context.h * \brief L&B API common context (publicly visible) and related definitions */ @@ -99,8 +99,13 @@ int edg_wll_SetParam( struct timeval; /* gcc, shut up! */ +/** Set an int context parameter */ int edg_wll_SetParamInt(edg_wll_Context,edg_wll_ContextParam,int); + +/** Set a string context parameter */ int edg_wll_SetParamString(edg_wll_Context,edg_wll_ContextParam,const char *); + +/** Set a timeval context parameter */ int edg_wll_SetParamTime(edg_wll_Context,edg_wll_ContextParam,const struct timeval *); /** Get current parameter value. @@ -165,7 +170,7 @@ typedef enum _edg_wll_ErrorCode { int edg_wll_Error( edg_wll_Context context, char **errText, - char **eddDesc + char **errDesc ); /** Convert source code to printable string @@ -195,7 +200,6 @@ edg_wll_QueryResults edg_wll_StringToQResult(const char *name); /** * initial sequence code for BigHelper */ - #define EDG_WLL_SEQ_BIGHELPER_INITIAL "UI=2:NS=0:WM=0:BH=1:JSS=0:LM=0:LRMS=0:APP=0" /** Retrieve current sequence code from the context */ diff --git a/org.glite.lb.client-interface/interface/events.h.T b/org.glite.lb.client-interface/interface/events.h.T index e37be1f..e4d0f89 100644 --- a/org.glite.lb.client-interface/interface/events.h.T +++ b/org.glite.lb.client-interface/interface/events.h.T @@ -2,7 +2,7 @@ #define __EDG_WORKLOAD_LOGGING_CLIENT_EVENTS_H__ /** - * \file edg/workload/logging/client/events.h + * \file events.h * \brief contains definition of event type codes for use both by lbapi.h and dglog.h */ @@ -139,7 +139,7 @@ for ($event->getFieldsOrdered) { # enum gen qq{ /** - * \\enum $enum + * \\$enum * $fn codes */ $enum \{ @@ -187,7 +187,7 @@ for my $t (sort { $event->{order}->{$a} <=> $event->{order}->{$b} } # enum gen qq{ /** - * \\enum $enum + * \\$enum * $fn codes of the $t event */ $enum \{ @@ -314,7 +314,7 @@ extern edg_wll_Event *edg_wll_InitEvent(edg_wll_EventCode eventcode); /** * Free the contents of event structure - * \param IN event structure to be freed + * \param event IN structure to be freed * \warning As event structures are likely to be allocated in arrays, * the structure itself is not freed. * Its the responsibility of the caller to call free(event) diff --git a/org.glite.lb.client-interface/interface/jobstat.h.T b/org.glite.lb.client-interface/interface/jobstat.h.T index 129b61d..802f119 100644 --- a/org.glite.lb.client-interface/interface/jobstat.h.T +++ b/org.glite.lb.client-interface/interface/jobstat.h.T @@ -6,7 +6,7 @@ */ /*! - * \file client/jobstat.h + * \file jobstat.h * \brief edg_wll_JobStat definition and related stuff */ diff --git a/org.glite.lb.client-interface/interface/producer.h.T b/org.glite.lb.client-interface/interface/producer.h.T index 188f25c..2cb2a75 100644 --- a/org.glite.lb.client-interface/interface/producer.h.T +++ b/org.glite.lb.client-interface/interface/producer.h.T @@ -2,7 +2,7 @@ #define __EDG_WORKLOAD_LOGGING_CLIENT_PRODUCER_H__ /** - * \file edg/workload/logging/client/producer.h + * \file producer.h * \brief client API for storing data into L&B service */ @@ -263,10 +263,10 @@ extern int edg_wll_LogFlushAll( /** * Set a current job for given context. * \note Should be called before any logging call. - * \param context INOUT context to work with - * \param job IN further logging calls are related to this job - * \param code IN sequence code as obtained from previous component - * \param flags IN flags on code handling (\see API documentation) + * \param context INOUT context to work with + * \param job IN further logging calls are related to this job + * \param code IN sequence code as obtained from previous component + * \param flags IN flags on code handling (\see API documentation) */ extern int edg_wll_SetLoggingJob( edg_wll_Context context, @@ -278,11 +278,11 @@ extern int edg_wll_SetLoggingJob( /** * Set a current job for given context. * \note Should be called before any logging call. - * \param context INOUT context to work with - * \param job IN further logging calls are related to this job - * \param code IN sequence code as obtained from previous component - * \param user IN user credentials - * \param flags IN flags on code handling (\see API documentation) + * \param context INOUT context to work with + * \param job IN further logging calls are related to this job + * \param code IN sequence code as obtained from previous component + * \param user IN user credentials + * \param flags IN flags on code handling (\see API documentation) */ extern int edg_wll_SetLoggingJobProxy( edg_wll_Context context, @@ -302,13 +302,15 @@ extern int edg_wll_SetLoggingJobProxy( * Partitionable jobs should set num_subjobs=0 initially, * and re-register when number of subjobs becomes known. * - * \param type IN EDG_WLL_JOB_SIMPLE, EDG_WLL_JOB_DAG, or EDG_WLL_JOB_PARTITIONABLE - * \param jdl IN user-specified JDL - * \param ns IN network server contact - * \param num_subjobs IN number of subjobs to create - * \param seed IN seed used for subjob id's generator. + * \param context INOUT context to work with + * \param job IN jobId + * \param type IN EDG_WLL_JOB_SIMPLE, EDG_WLL_JOB_DAG, or EDG_WLL_JOB_PARTITIONABLE + * \param jdl IN user-specified JDL + * \param ns IN network server contact + * \param num_subjobs IN number of subjobs to create + * \param seed IN seed used for subjob id's generator. * Use non-NULL value to be able to regenerate the set of jobid's - * \param subjobs OUT returned subjob id's + * \param subjobs OUT returned subjob id's */ /* backward compatibility */ @@ -349,14 +351,16 @@ extern int edg_wll_RegisterJobSync( * Partitionable jobs should set num_subjobs=0 initially, * and re-register when number of subjobs becomes known. * - * \param type IN EDG_WLL_JOB_SIMPLE, EDG_WLL_JOB_DAG, or EDG_WLL_JOB_PARTITIONABLE - * \param user IN user credentials - * \param jdl IN user-specified JDL - * \param ns IN network server contact - * \param num_subjobs IN number of subjobs to create - * \param seed IN seed used for subjob id's generator. + * \param context INOUT context to work with + * \param job IN jobId + * \param type IN EDG_WLL_JOB_SIMPLE, EDG_WLL_JOB_DAG, or EDG_WLL_JOB_PARTITIONABLE + * \param user IN user credentials + * \param jdl IN user-specified JDL + * \param ns IN network server contact + * \param num_subjobs IN number of subjobs to create + * \param seed IN seed used for subjob id's generator. * Use non-NULL value to be able to regenerate the set of jobid's - * \param subjobs OUT returned subjob id's + * \param subjobs OUT returned subjob id's */ extern int edg_wll_RegisterJobProxy( @@ -376,8 +380,11 @@ extern int edg_wll_RegisterJobProxy( * Register subjobs in a batch. * Mainly used to provide JDL's of individual subjobs in a more efficient * way than logging them one by one. - * \param jdls array of JDL's - * \param subjobs array of jobid's in the same order + * \param context INOUT context to work with + * \param parent IN parent's jobId + * \param jdls IN array of JDL's + * \param ns IN network server contact + * \param subjobs OUT array of jobid's in the same order */ extern int edg_wll_RegisterSubjobs( @@ -427,13 +434,15 @@ enum edg_wll_UserIdType { /** * Change ACL for given job. - * \param specification of user's credential - * \param user_id_type type of user_id, + * \param context INOUT context to work with + * \param job IN jobId + * \param user_id IN specification of user's credential + * \param user_id_type IN type of user_id, * for EDG_WLL_USER_SUBJECT the user_id parameter is expected to be user's subject name * for EDG_WLL_USER_VOMS_GROUP the user_id is expected to be of the form VO:group specifying required group membersip as managed by VOMS - * \param permission ACL permission to change + * \param permission ACL permission to change * \param permission_type type of given permission (allow or deny operation) - * \param operation operation to perform with ACL (add or remove record) + * \param operation operation to perform with ACL (add or remove record) */ extern int edg_wll_ChangeACL( diff --git a/org.glite.lb.client-interface/project/configure.properties.xml b/org.glite.lb.client-interface/project/configure.properties.xml index f894934..f9721e7 100644 --- a/org.glite.lb.client-interface/project/configure.properties.xml +++ b/org.glite.lb.client-interface/project/configure.properties.xml @@ -20,6 +20,9 @@ Revision history: $Log$ + Revision 1.2 2004/12/08 13:04:29 jpospi + first attemtp to generate documentation using doxygen + Revision 1.1 2004/07/06 17:47:31 flammer Update of classpath definitions, targets & configure file. @@ -55,17 +58,19 @@ PREFIX=${install.dir} version=${module.version} -PROJECT_NAME = "Glite LB Client: C - Interface" -PROJECT_NUMBER = ${module.version} -OUTPUT_DIRECTORY = ${component.dir}/doc/C -OPTIMIZE_OUTPUT_FOR_C = YES -INPUT = ./events.h \ - ./jobstat.h \ - ./producer.h \ - ../interface/context.h \ - ../interface/consumer.h -#HAVE_DOT = YES -#CALL_GRAPH = YES +PROJECT_NAME = "Glite LB Client: C - Interface" +PROJECT_NUMBER = ${module.version} +OUTPUT_DIRECTORY = ${component.dir}/doc/C +OPTIMIZE_OUTPUT_FOR_C = YES +INPUT = ./events.h \ + ./jobstat.h \ + ./producer.h \ + ../interface/context.h \ + ../interface/consumer.h +SHOW_DIRECTORIES = NO +EXTRACT_ALL = YES +#HAVE_DOT = YES +#CALL_GRAPH = YES PROJECT_NAME = "Glite LB Client: CPP - Interface" @@ -78,6 +83,8 @@ INPUT = ../build/Event.h \ ../interface/LoggingExceptions.h \ ../interface/ServerConnection.h \ ../interface/Notification.h +SHOW_DIRECTORIES = NO +EXTRACT_ALL = YES #HAVE_DOT = YES #CALL_GRAPH = YES -- 1.8.2.3