path: root/src/pulsecore
diff options
authorMads Kiilerich <>2009-12-11 16:20:31 +0100
committerLennart Poettering <>2010-01-05 21:27:33 +0100
commit6faf38313e5f313cbcfe5c78af1dd310131798d2 (patch)
tree763963d6d62252b5a7ec345752e3f36e08b71471 /src/pulsecore
parent0e47065fe5a410bcb7c367c23fc4d99b71fd82b2 (diff)
headers: Some trivial fixes for some documentation typos
Note also the willneed/will_need inconsistency. I guess it could be nice to ASAP choose one of them and introduce a backward compatibility hack for the other. The issues was mostly found with: for a in $(grep -r '^[ /]\*.*()' $( find -name '*.[ch]') | sed 's,^.* \([^ ]*\)().*$,\1,g' | sort | uniq | grep ^pa_) do grep -rq "^.[^*].*\<$a(" $(find * -name '*.h') || echo $a done
Diffstat (limited to 'src/pulsecore')
3 files changed, 5 insertions, 4 deletions
diff --git a/src/pulsecore/asyncq.h b/src/pulsecore/asyncq.h
index e6847ab8..47ccbf03 100644
--- a/src/pulsecore/asyncq.h
+++ b/src/pulsecore/asyncq.h
@@ -48,8 +48,9 @@ void pa_asyncq_free(pa_asyncq* q, pa_free_cb_t free_cb);
void* pa_asyncq_pop(pa_asyncq *q, pa_bool_t wait);
int pa_asyncq_push(pa_asyncq *q, void *p, pa_bool_t wait);
-/* Similar to pa_asyncq_push(), but if the queue is full, postpone it
- * locally and delay until pa_asyncq_before_poll_post() */
+/* Similar to pa_asyncq_push(), but if the queue is full, postpone the
+ * appending of the item locally and delay until
+ * pa_asyncq_before_poll_post() is called. */
void pa_asyncq_post(pa_asyncq*l, void *p);
/* For the reading side */
diff --git a/src/pulsecore/aupdate.h b/src/pulsecore/aupdate.h
index fb38ffa2..48871126 100644
--- a/src/pulsecore/aupdate.h
+++ b/src/pulsecore/aupdate.h
@@ -39,7 +39,7 @@ void pa_aupdate_write_end(pa_aupdate *a);
/* Will return 0, or 1, depending which copy of the data the caller
* should modify. Each time called this will return the opposite of
- * the previous pa_aupdate_write_begin()/pa_aupdate_write_swap()
+ * the previous pa_aupdate_write_begin() / pa_aupdate_write_swap()
* call. Should only be called between pa_aupdate_write_begin() and
* pa_aupdate_write_end() */
unsigned pa_aupdate_write_swap(pa_aupdate *a);
diff --git a/src/pulsecore/memblockq.h b/src/pulsecore/memblockq.h
index 587c364b..b756549a 100644
--- a/src/pulsecore/memblockq.h
+++ b/src/pulsecore/memblockq.h
@@ -165,7 +165,7 @@ void pa_memblockq_set_silence(pa_memblockq *memblockq, pa_memchunk *silence);
void pa_memblockq_apply_attr(pa_memblockq *memblockq, const pa_buffer_attr *a);
void pa_memblockq_get_attr(pa_memblockq *bq, pa_buffer_attr *a);
-/* Call pa_memchunk_willneed() for every chunk in the queue from the current read pointer to the end */
+/* Call pa_memchunk_will_need() for every chunk in the queue from the current read pointer to the end */
void pa_memblockq_willneed(pa_memblockq *bq);
/* Check whether the memblockq is completely empty, i.e. no data