Updated documentation of the public member functions

diff --git a/org.glite.lb.client-interface/interface/Notification.h b/org.glite.lb.client-interface/interface/Notification.h
index b8e8b27..4ce8fe4 100644 (file)
--- a/org.glite.lb.client-interface/interface/Notification.h
+++ b/org.glite.lb.client-interface/interface/Notification.h
@@ -23,18 +23,18 @@ public:
         */
        Notification();
 
-       /** Create from server,port pair
+       /** Create from server host,port pair
         * to be used for new notifications, i.e. with Register()
-        * \param host
-        * \param port
+        * \param host          IN host
+        * \param port          IN port
         */
-       Notification(const std::string,const u_int16_t);
+       Notification(const std::string host,const u_int16_t port);
 
        /** Create from NotifId
         * to be used for existing notifications, i.e. with Bind()
-        * \param notifId
+        * \param notifId       IN NotifId
         */
-       Notification(const std::string);
+       Notification(const std::string notifId);
 
        ~Notification();
 
@@ -45,11 +45,14 @@ public:
        /** Add this job to the list.
         * Local operation only, Register() has to be called
         * to propagate changes to server 
+        * \param jobId         IN JobId
         */
-       void addJob(const glite::wmsutils::jobid::JobId &); 
+       void addJob(const glite::wmsutils::jobid::JobId &jobId); 
 
-       /** Remove job from the list, local op again. */
-       void removeJob(const glite::wmsutils::jobid::JobId &);
+       /** Remove job from the list, local op again. 
+        * \param jobId         IN JobId
+        */
+       void removeJob(const glite::wmsutils::jobid::JobId &jobId);
 
        /** Get jobs on the list */
        std::string getJobs();
@@ -67,9 +70,9 @@ public:
 
        /** Bind to the existing notification at the server
         * i.e. change the receiving local address
-        * \param address_override
+        * \param address       IN address override
         */
-       void Bind(const std::string);
+       void Bind(const std::string address);
 
        /** Receive notification.
         * Blocks at most the specified timeout (maybe 0 for local polling).

diff --git a/org.glite.lb.client-interface/interface/ServerConnection.h b/org.glite.lb.client-interface/interface/ServerConnection.h
index 333d0bd..05e277d 100644 (file)
--- a/org.glite.lb.client-interface/interface/ServerConnection.h
+++ b/org.glite.lb.client-interface/interface/ServerConnection.h
@@ -178,7 +178,7 @@ public:
         */
        void queryEvents(const std::vector<QueryRecord>& job_cond,
                         const std::vector<QueryRecord>& event_cond,
-                        std::vector<Event>&) const;
+                        std::vector<Event>& events) const;
   
        const std::vector<Event> queryEvents(const std::vector<QueryRecord>& job_cond,
                                             const std::vector<QueryRecord>& event_cond) const;
@@ -200,14 +200,14 @@ public:
   
 
        /** Retrieve all events satisfying the query records
-        * @param job_cond, event_cond - vectors of vectors of job or event conditions, 
+        * @param job_cond, event_cond  IN vectors of vectors of job or event conditions, 
         * respectively. The inner vectors are logically ANDed, the outer are ORed
         * (cond1 AND cond2 AND ...) OR (condN AND ...)
-        * @param events vector of returned events
+        * @param eventList     OUT vector of returned events
         */
        void queryEvents(const std::vector<std::vector<QueryRecord> >& job_cond,
                         const std::vector<std::vector<QueryRecord> >& event_cond,
-                        std::vector<Event>&) const;
+                        std::vector<Event>& eventList) const;
   
        const std::vector<Event> 
        queryEvents(const std::vector<std::vector<QueryRecord> >& job_cond,
@@ -215,38 +215,32 @@ public:
 
        
        /** Retrieve jobs satisfying the query records, including their states
-        * @param query vector of Query records that are anded to form the
-        *      query
-        * @param ids vector of returned job id's
-        * @param states vector of returned job states
+        * @param query         IN vector of Query records that are ANDed to form the query
+        * @param jobList       OUT vector of returned job id's
         */
   
        void queryJobs(const std::vector<QueryRecord>& query,
-                      std::vector<glite::wmsutils::jobid::JobId>& ids) const;
+                      std::vector<glite::wmsutils::jobid::JobId>& jobList) const;
   
        const std::vector<glite::wmsutils::jobid::JobId>
        queryJobs(const std::vector<QueryRecord>& query) const;
   
        
        /** Retrieve jobs satisfying the query records, including their states
-        * @param query vector of Query record vectors that are ORed and ANDed to form the
-        *      query
-        * @param ids vector of returned job id's
-        * @param states vector of returned job states
+        * @param query         IN vector of Query record vectors that are ORed and ANDed to form the query
+        * @param jobList       OUT vector of returned job id's
         */
    
        void queryJobs(const std::vector<std::vector<QueryRecord> >& query,
-                      std::vector<glite::wmsutils::jobid::JobId>& ids) const;
+                      std::vector<glite::wmsutils::jobid::JobId>& jobList) const;
   
        const std::vector<glite::wmsutils::jobid::JobId>
        queryJobs(const std::vector<std::vector<QueryRecord> >& query) const;
 
-       /** Retrieve jobs satisfying the query records, including status
-        * information
-        * @param query vector of Query records that are anded to form the
-        *      query
-        * @param ids vector of returned job id's
-        * @param states vector of returned job states
+       /** Retrieve jobs satisfying the query records, including status information
+        * @param query         IN vector of Query records that are ANDed to form the query
+        * @param flags         IN flags
+        * @param states        OUT vector of returned job states
         */
        void queryJobStates(const std::vector<QueryRecord>& query, 
                            int flags,
@@ -257,12 +251,10 @@ public:
        const std::list<JobStatus>  queryJobStatesList(const std::vector<QueryRecord>& query,
                                                     int flags) const;
   
-       /** Retrieve jobs satisfying the query records, including status
-        * information
-        * @param query vector of Query records that are anded to form the
-        *      query
-        * @param ids vector of returned job id's
-        * @param states vector of returned job states
+       /** Retrieve jobs satisfying the query records, including status information
+        * @param query         IN vector of Query records that are anded to form the query
+        * @param flags         IN flags
+        * @param states        OUT vector of returned job states
         */
        void queryJobStates(const std::vector<std::vector<QueryRecord> >& query, 
                            int flags,