Revision 4affd2bf include/chunkidset.h

View differences:

include/chunkidset.h
14 14
#define CIST_BITMAP 1
15 15
#define CIST_PRIORITY 2
16 16

  
17

  
18
/**
19
* Opaque data type representing a Chunk ID Set
20
*/
17 21
typedef struct chunkID_set ChunkIDSet;
18 22

  
19 23
 /**
......
21 25
  * 
22 26
  * Create an empty chunk ID set, and return a pointer to it.
23 27
  * 
24
  * @parameter config a configuration string containing tags which describe
28
  * @param config a configuration string containing tags which describe
25 29
  *                   the chunk ID set. For example, the "size" tag indicates
26 30
  *                   the expected number of chunk IDs that will be stored
27 31
  *                   in the set; 0 or not present if such a number is not
......
37 41
  * to depend on the insertion order), to the set. If the chunk
38 42
  * ID is already in the set, nothing happens.
39 43
  *
40
  * @parameter h a pointer to the set where the chunk ID has to be added
41
  * @parameter chunk_id the ID of the chunk to be inserted in the set
44
  * @param h a pointer to the set where the chunk ID has to be added
45
  * @param chunk_id the ID of the chunk to be inserted in the set
42 46
  * @return > 0 if the chunk ID is correctly inserted in the set, 0 if chunk_id
43 47
  *         is already in the set, < 0 on error
44 48
  */
......
49 53
  * 
50 54
  * Return the number of chunk IDs present in a set.
51 55
  *
52
  * @parameter h a pointer to the set
56
  * @param h a pointer to the set
53 57
  * @return the number of chunk IDs in the set, or < 0 on error
54 58
  */
55 59
int chunkID_set_size(const struct chunkID_set *h);
......
60 64
  * Return the i^th chunk ID from the set. The chunk's priority is
61 65
  * assumed to depend on i.
62 66
  *
63
  * @parameter h a pointer to the set
64
  * @parameter i the index of the chunk ID to be returned
67
  * @param h a pointer to the set
68
  * @param i the index of the chunk ID to be returned
65 69
  * @return the i^th chunk ID in the set in case of success, or < 0 on error
66 70
  *         (in case of error, priority is not meaningful)
67 71
  */
......
70 74
 /**
71 75
  * Check if a chunk ID is in a set
72 76
  * 
73
  * @parameter h a pointer to the set
74
  * @parameter chunk_id the chunk ID we are searching for
77
  * @param h a pointer to the set
78
  * @param chunk_id the chunk ID we are searching for
75 79
  * @return the priority of the chunk ID if it is present in the set,
76 80
  *         < 0 on error or if the chunk ID is not in the set
77 81
  */
......
84 88
  * kept in the old one. New chunks from the added one are added with
85 89
  * lower priorities, but keeping their order.
86 90
  *
87
  * @parameter h a pointer to the set where the chunk ID has to be added
88
  * @parameter a a pointer to the set which has to be added
91
  * @param h a pointer to the set where the chunk ID has to be added
92
  * @param a a pointer to the set which has to be added
89 93
  * @return > 0 if the chunk ID is correctly inserted in the set, 0 if chunk_id
90 94
  *         is already in the set, < 0 on error
91 95
  */
......
96 100
  * 
97 101
  * Remove all the chunk IDs from a set.
98 102
  *
99
  * @parameter h a pointer to the set
100
  * @parameter size the expected number of chunk IDs that will be stored
103
  * @param h a pointer to the set
104
  * @param size the expected number of chunk IDs that will be stored
101 105
  *                 in the set; 0 if such a number is not known.
102 106
  */
103 107
void chunkID_set_clear(struct chunkID_set *h, int size);
......
105 109
 /**
106 110
  * Clear a set and free all associated memory.
107 111
  *
108
  * @parameter h a pointer to the set
112
  * @param h a pointer to the set
109 113
  */
110 114
void chunkID_set_free(struct chunkID_set *h);
111 115

  

Also available in: Unified diff