add some doc

Author: YruamaLairba

log/src/lib.rs

@@ -9,27 +9,31 @@ unsafe impl UriBound for EntryClass {
     const URI: &'static [u8] = lv2_sys::LV2_LOG__Entry;
 }
 
+/// UriBound for an error message.
 pub struct ErrorClass;
 unsafe impl UriBound for ErrorClass {
     const URI: &'static [u8] = lv2_sys::LV2_LOG__Error;
 }
 
+/// UriBound for an informative message.
 pub struct NoteClass;
 unsafe impl UriBound for NoteClass {
     const URI: &'static [u8] = lv2_sys::LV2_LOG__Note;
 }
 
+/// UriBound for a debuging message.
 pub struct TraceClass;
 unsafe impl UriBound for TraceClass {
     const URI: &'static [u8] = lv2_sys::LV2_LOG__Trace;
 }
 
+/// Uribound for an error message.
 pub struct WarningClass;
 unsafe impl UriBound for WarningClass {
     const URI: &'static [u8] = lv2_sys::LV2_LOG__Warning;
 }
 
-/// Marker for URID representing the nature of a log message
+/// Marker for URID representing the nature of a log message.
 // Note : it's may be better to have a URID trait to define a common interface
 pub unsafe trait EntryType
 where
@@ -59,7 +63,7 @@ unsafe impl EntryType for URID<WarningClass> {
     }
 }
 
-/// Errors potentially generated by [`Log`](struct.Log.html) methods
+/// Errors potentially generated by [`Log`](struct.Log.html) methods.
 #[derive(PartialEq, Eq, Clone, Copy, Debug)]
 pub enum LogError {
     /// An error occured when sending message to the host
@@ -72,7 +76,7 @@ pub enum LogError {
     NoCallback,
 }
 
-/// The Log feature
+/// The Log feature.
 #[repr(transparent)]
 pub struct Log<'a> {
     internal: &'a lv2_sys::LV2_Log_Log,
@@ -93,6 +97,17 @@ unsafe impl<'a> Feature for Log<'a> {
 }
 
 impl<'a> Log<'a> {
+    /// Send a log message to the host.
+    ///
+    /// the `entry_type` parameter is an URID representing the kind of log message. There are four
+    /// kind of message:
+    /// * **note:** an informative message.
+    /// * **warning:** a warning message.
+    /// * **error:** an error message.
+    /// * **trace:** a debugging trace. These entries should not be displayed during normal
+    /// operation, but the host may implement an option to display them for debugging purposes.
+    /// This entry type is special in that it may be written to in a real-time thread. It is
+    /// assumed that if debug tracing is enabled, real-time considerations are not a concern.
     pub fn print(&self, entry_type: impl EntryType, message: &str) -> Result<(), LogError> {
         let printf = if let Some(printf) = self.internal.printf {
             printf
@@ -127,7 +142,7 @@ impl<'a> Log<'a> {
     }
 }
 
-/// A URID cache containing all time properties.
+/// A URID cache containing all log properties.
 #[derive(URIDCollection, Debug)]
 pub struct LogURIDCollection {
     pub entry_class: URID<EntryClass>,