Merge pull request #230 from myd7349/update-doc

Update docs

Author: tstenner

README.md

@@ -81,8 +81,7 @@ To connect an application to the lab streaming layer:
 * To receive data, resolve a stream that matches your citeria (e.g. name or type), which gives you a 
   streaminfo and create a new inlet with that streaminfo. Pull samples from the inlet. 
   Destroy the inlet when you're done.
-* Have a look at the example sources in the
-  [examples/ folder](https://github.com/labstreaminglayer/App-Examples)
+* Have a look at the example sources in the [`examples/`](examples/) folder.
 
 The library and example applications are licensed under the MIT license.  
 The library uses code that is licensed under the Boost software license.

include/lsl/outlet.h

@@ -69,6 +69,7 @@ extern LIBLSL_C_API int32_t lsl_push_sample_v(lsl_outlet out, const void *data);
 /// @}
 /** @copydoc lsl_push_sample_f
  * @param timestamp Optionally the capture time of the sample, in agreement with
+ * lsl_local_clock(); if omitted, the current time is used.
  * @{
  */
 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
  * fields assigned).
  * @return A copy of the streaminfo of the outlet or NULL in the event that an error occurred.
  * @note It is the user's responsibility to destroy it when it is no longer needed.
- * @sa lsl_destroy_string()
+ * @sa lsl_destroy_streaminfo()
  */
 extern LIBLSL_C_API lsl_streaminfo lsl_get_info(lsl_outlet out);
 

include/lsl/resolver.h

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

include/lsl/streaminfo.h

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

include/lsl_cpp.h

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