瀏覽代碼

doc/doxygen: more documentation

Nathalie Furmento 12 年之前
父節點
當前提交
2979b43f4d
共有 2 個文件被更改,包括 8 次插入13 次删除
  1. 7 11
      doc/doxygen/chapters/api/scheduling_contexts.doxy
  2. 1 2
      doc/doxygen/chapters/api/workers.doxy

+ 7 - 11
doc/doxygen/chapters/api/scheduling_contexts.doxy

@@ -54,24 +54,20 @@ structures(like tree) implementations are foreseen.
         The workerids managed by the collection
         The workerids managed by the collection
 \var starpu_worker_collection::nworkers
 \var starpu_worker_collection::nworkers
         The number of workers in the collection
         The number of workers in the collection
-\var starpu_worker_collection::    int type
+\var starpu_worker_collection::type
         The type of structure (currently STARPU_WORKER_LIST is the only one available)
         The type of structure (currently STARPU_WORKER_LIST is the only one available)
-\var starpu_worker_collection::    unsigned (*has_next)(struct starpu_worker_collection *workers)
+\var starpu_worker_collection::has_next
         Checks if there is a next worker
         Checks if there is a next worker
-\var starpu_worker_collection::    int (*get_next)(struct starpu_worker_collection *workers)
+\var starpu_worker_collection::get_next
         Gets the next worker
         Gets the next worker
-\var starpu_worker_collection::    int (*add)(struct starpu_worker_collection *workers, int worker)
+\var starpu_worker_collection::add
         Adds a worker to the collection
         Adds a worker to the collection
-\var starpu_worker_collection::    int (*remove)(struct starpu_worker_collection *workers, int worker)
+\var starpu_worker_collection::remove
         Removes a worker from the collection
         Removes a worker from the collection
-\var starpu_worker_collection::    void* (*init)(struct starpu_worker_collection *workers)
+\var starpu_worker_collection::init
         Initialize the collection
         Initialize the collection
-\var starpu_worker_collection::    void (*deinit)(struct starpu_worker_collection *workers)
+\var starpu_worker_collection::deinit
         Deinitialize the colection
         Deinitialize the colection
-\var starpu_worker_collection::    void (*init_cursor)(struct starpu_worker_collection *workers) (optional)
-        Initialize the cursor if there is one
-\var starpu_worker_collection::    void (*deinit_cursor)(struct starpu_worker_collection *workers) (optional)
-        Deinitialize the cursor if there is one
 
 
 \fn struct starpu_worker_collection* starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, int type)
 \fn struct starpu_worker_collection* starpu_sched_ctx_create_worker_collection(unsigned sched_ctx_id, int type)
 \ingroup Scheduling_Contexts
 \ingroup Scheduling_Contexts

+ 1 - 2
doc/doxygen/chapters/api/workers.doxy

@@ -12,7 +12,7 @@
 \ingroup Workers_Properties
 \ingroup Workers_Properties
 \brief This function returns the number of workers (i.e. processing
 \brief This function returns the number of workers (i.e. processing
 units executing StarPU tasks). The returned value should be at most
 units executing StarPU tasks). The returned value should be at most
-STARPU_NMAXWORKERS. 
+STARPU_NMAXWORKERS.
 
 
 \fn int starpu_worker_get_count_by_type(enum starpu_worker_archtype type)
 \fn int starpu_worker_get_count_by_type(enum starpu_worker_archtype type)
 \ingroup Workers_Properties
 \ingroup Workers_Properties
@@ -112,4 +112,3 @@ this function should be used in the allocation function to determine
 on which device the memory needs to be allocated.
 on which device the memory needs to be allocated.
 
 
 */
 */
-