Skip to content

Commit 03df751

Browse files
committed
Update docs
1 parent 7e61a2e commit 03df751

File tree

5 files changed

+7
-8
lines changed

5 files changed

+7
-8
lines changed

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,7 @@ To connect an application to the lab streaming layer:
8181
* To receive data, resolve a stream that matches your citeria (e.g. name or type), which gives you a
8282
streaminfo and create a new inlet with that streaminfo. Pull samples from the inlet.
8383
Destroy the inlet when you're done.
84-
* Have a look at the example sources in the
85-
[examples/ folder](https://github.com/labstreaminglayer/App-Examples)
84+
* Have a look at the example sources in the [`examples/`](examples/) folder.
8685

8786
The library and example applications are licensed under the MIT license.
8887
The library uses code that is licensed under the Boost software license.

include/lsl/outlet.h

+2-1
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ extern LIBLSL_C_API int32_t lsl_push_sample_v(lsl_outlet out, const void *data);
6969
/// @}
7070
/** @copydoc lsl_push_sample_f
7171
* @param timestamp Optionally the capture time of the sample, in agreement with
72+
* lsl_local_clock(); if omitted, the current time is used.
7273
* @{
7374
*/
7475
extern LIBLSL_C_API int32_t lsl_push_sample_ft(lsl_outlet out, const float *data, double timestamp);
@@ -244,7 +245,7 @@ extern LIBLSL_C_API int32_t lsl_wait_for_consumers(lsl_outlet out, double timeou
244245
* fields assigned).
245246
* @return A copy of the streaminfo of the outlet or NULL in the event that an error occurred.
246247
* @note It is the user's responsibility to destroy it when it is no longer needed.
247-
* @sa lsl_destroy_string()
248+
* @sa lsl_destroy_streaminfo()
248249
*/
249250
extern LIBLSL_C_API lsl_streaminfo lsl_get_info(lsl_outlet out);
250251

include/lsl/resolver.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
/**
1616
* Construct a new #lsl_continuous_resolver that resolves all streams on the network.
1717
*
18-
* This is analogous to the functionality offered by the free function lsl_resolve_streams().
18+
* This is analogous to the functionality offered by the free function lsl_resolve_all().
1919
* @param forget_after When a stream is no longer visible on the network (e.g. because it was shut
2020
* down), this is the time in seconds after which it is no longer reported by the resolver.
2121
*

include/lsl/streaminfo.h

+1-1
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ extern LIBLSL_C_API lsl_xml_ptr lsl_get_desc(lsl_streaminfo info);
160160
* This yields an XML document (in string form) whose top-level element is `<info>`. The info
161161
* element contains one element for each field of the streaminfo class, including:
162162
*
163-
* - the core elements `<name>`, `<type>`, `<channel_count`, `<nominal_srate>`,
163+
* - the core elements `<name>`, `<type>`, `<channel_count>`, `<nominal_srate>`,
164164
* `<channel_format>`, `<source_id>`
165165
* - the misc elements `<version>`, `<created_at>`, `<uid>`, `<session_id>`,
166166
* `<v4address>`, `<v4data_port>`, `<v4service_port>`, `<v6address>`, `<v6data_port>`,

include/lsl_cpp.h

+2-3
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ class stream_info {
336336
* This yields an XML document (in string form) whose top-level element is `<info>`. The info
337337
* element contains one element for each field of the streaminfo class, including:
338338
*
339-
* - the core elements `<name>`, `<type>`, `<channel_count`, `<nominal_srate>`,
339+
* - the core elements `<name>`, `<type>`, `<channel_count>`, `<nominal_srate>`,
340340
* `<channel_format>`, `<source_id>`
341341
* - the misc elements `<version>`, `<created_at>`, `<uid>`, `<session_id>`,
342342
* `<v4address>`, `<v4data_port>`, `<v4service_port>`, `<v6address>`, `<v6data_port>`,
@@ -1484,8 +1484,7 @@ class stream_inlet {
14841484
* Has a name and can have multiple named children or have text content as value; attributes are
14851485
* omitted. Insider note: The interface is modeled after a subset of pugixml's node type and is
14861486
* compatible with it. See also
1487-
* http://pugixml.googlecode.com/svn/tags/latest/docs/manual/access.html for additional
1488-
* documentation.
1487+
* https://pugixml.org/docs/manual.html#access for additional documentation.
14891488
*/
14901489
class xml_element {
14911490
public:

0 commit comments

Comments
 (0)