]> code.delx.au - pulseaudio/commitdiff
doc: Assorted spelling and grammar fixes for doxygen output
authorPeter Meerwald <pmeerw@pmeerw.net>
Thu, 20 Feb 2014 20:41:47 +0000 (21:41 +0100)
committerPeter Meerwald <pmeerw@pmeerw.net>
Sun, 23 Feb 2014 16:03:50 +0000 (17:03 +0100)
Signed-off-by: Peter Meerwald <pmeerw@pmeerw.net>
src/pulse/context.h
src/pulse/def.h
src/pulse/stream.h
src/pulse/thread-mainloop.h

index 3b8b9be7f353d9c47eee4b2e2513007d763566ea..68516a27d81335e31221dad0533f183097a02bc7 100644 (file)
@@ -87,7 +87,7 @@
  * Whenever the library creates an object, it will have an initial
  * reference count of one. Most of the time, this single reference will be
  * sufficient for the application, so all required reference count
- * interaction will be a single call to the objects unref function.
+ * interaction will be a single call to the object's unref function.
  *
  * \section context_sec Context
  *
index a01c902196393fd36af09b7f0c3915368e35d07b..d6fa9120100fc5616663f7257c3bc7a9618d4858 100644 (file)
@@ -326,7 +326,7 @@ typedef enum pa_stream_flags {
      * PA_STREAM_ADJUST_LATENCY. \since 0.9.12 */
 
     PA_STREAM_DONT_INHIBIT_AUTO_SUSPEND = 0x8000U,
-    /**< If set this stream won't be taken into account when we it is
+    /**< If set this stream won't be taken into account when it is
      * checked whether the device this stream is connected to should
      * auto-suspend. \since 0.9.15 */
 
index 49f5789ad922c64452d0e487e2fdb0e97b580ea8..47e0c6868a14cb07536115f69d81b34db1e2b55f 100644 (file)
  *              (which is recommended) the server will choose the same
  *              value as tlength here.
  *
- * \li minreq - Minimum free number of the bytes in the playback
+ * \li minreq - Minimum number of free bytes in the playback
  *              buffer before the server will request more data. It is
  *              recommended to fill in (uint32_t) -1 here. This value
  *              influences how much time the sound server has to move
  * PA_STREAM_ADJUST_LATENCY if you want to control the overall
  * playback latency for your stream. Unset it if you want to control
  * only the latency induced by the server-side, rewritable playback
- * buffer. The server will try to fulfill the clients latency requests
+ * buffer. The server will try to fulfill the client's latency requests
  * as good as possible. However if the underlying hardware cannot
  * change the hardware buffer length or only in a limited range, the
  * actually resulting latency might be different from what the client
  * requested. Thus, for synchronization clients always need to check
  * the actual measured latency via pa_stream_get_latency() or a
- * similar call, and not make any assumptions. about the latency
+ * similar call, and not make any assumptions about the latency
  * available. The function pa_stream_get_buffer_attr() will always
  * return the actual size of the server-side per-stream buffer in
  * tlength/fragsize, regardless whether PA_STREAM_ADJUST_LATENCY is
@@ -434,7 +434,7 @@ int pa_stream_is_suspended(pa_stream *s);
 int pa_stream_is_corked(pa_stream *s);
 
 /** Connect the stream to a sink. It is strongly recommended to pass
- * NULL in both \a dev and \a volume and not to set either
+ * NULL in both \a dev and \a volume and to set neither
  * PA_STREAM_START_MUTED nor PA_STREAM_START_UNMUTED -- unless these
  * options are directly dependent on user input or configuration.
  *
index f1636e83a232ce0334e68615b2aee48507f93cfa..8e8cbfeba95c29dd74ddfbe41c0543332298e23d 100644 (file)
@@ -226,7 +226,7 @@ PA_C_DECL_BEGIN
  * that they can be called at any time. The threaded main loop API provides
  * the locking mechanism to handle concurrent accesses, but nothing else.
  * Applications will have to handle communication from the callback to the
- * main program through its own mechanisms.
+ * main program through their own mechanisms.
  *
  * The callbacks that are completely asynchronous are:
  *