diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-07 23:20:46 +0900 |
---|---|---|
committer | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2022-07-07 23:20:46 +0900 |
commit | 626b882e1779bb0f8cbf1ff64ce7b65803bc46fc (patch) | |
tree | 9e130ceeb3fe749b801352c5ebb3faa7f0245694 | |
parent | 3feaad484a9464061d3ef89a6a953220f2006a5d (diff) | |
download | hinoko-rs-626b882e1779bb0f8cbf1ff64ce7b65803bc46fc.tar.gz |
hinoko: add document alias to manual implementations
The gir tool generate document alias to implementations generated
automatically, while not to manual implementations.
This commit adds them.
Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
-rw-r--r-- | hinoko/src/cycle_timer.rs | 2 | ||||
-rw-r--r-- | hinoko/src/fw_iso_ctx.rs | 1 | ||||
-rw-r--r-- | hinoko/src/fw_iso_rx_multiple.rs | 4 | ||||
-rw-r--r-- | hinoko/src/fw_iso_rx_single.rs | 5 | ||||
-rw-r--r-- | hinoko/src/fw_iso_tx.rs | 3 |
5 files changed, 15 insertions, 0 deletions
diff --git a/hinoko/src/cycle_timer.rs b/hinoko/src/cycle_timer.rs index 1709a6d..b7cfe7c 100644 --- a/hinoko/src/cycle_timer.rs +++ b/hinoko/src/cycle_timer.rs @@ -2,6 +2,8 @@ use crate::*; impl CycleTimer { + #[doc(alias = "hinoko_cycle_timer_get_cycle_timer")] + #[doc(alias = "get_cycle_timer")] pub fn cycle_timer(&mut self) -> [u16; 3] { unsafe { let mut cycle_timer = [0; 3]; diff --git a/hinoko/src/fw_iso_ctx.rs b/hinoko/src/fw_iso_ctx.rs index 5d20069..491107a 100644 --- a/hinoko/src/fw_iso_ctx.rs +++ b/hinoko/src/fw_iso_ctx.rs @@ -2,6 +2,7 @@ use crate::*; pub trait FwIsoCtxExtManual { + #[doc(alias = "hinoko_fw_iso_ctx_get_cycle_timer")] fn get_cycle_timer(&self, clock_id: i32, cycle_timer: &mut CycleTimer) -> Result<(), Error>; } diff --git a/hinoko/src/fw_iso_rx_multiple.rs b/hinoko/src/fw_iso_rx_multiple.rs index 5007c22..59fe61d 100644 --- a/hinoko/src/fw_iso_rx_multiple.rs +++ b/hinoko/src/fw_iso_rx_multiple.rs @@ -3,10 +3,12 @@ use crate::*; pub trait FwIsoRxMultipleExtManual { fn channels(&self) -> Option<Vec<u8>>; + #[doc(alias = "channels")] fn connect_channels_notify<F>(&self, f: F) -> SignalHandlerId where F: Fn(&Self) + 'static; + #[doc(alias = "hinoko_fw_iso_rx_multiple_start")] fn start( &self, cycle_match: Option<&[u16; 2]>, @@ -15,6 +17,8 @@ pub trait FwIsoRxMultipleExtManual { chunks_per_irq: u32, ) -> Result<(), Error>; + #[doc(alias = "hinoko_fw_iso_rx_multiple_get_payload")] + #[doc(alias = "get_payload")] fn payload(&self, index: u32) -> &[u8]; } diff --git a/hinoko/src/fw_iso_rx_single.rs b/hinoko/src/fw_iso_rx_single.rs index 346d47e..9283f9e 100644 --- a/hinoko/src/fw_iso_rx_single.rs +++ b/hinoko/src/fw_iso_rx_single.rs @@ -2,6 +2,7 @@ use crate::*; pub trait FwIsoRxSingleExtManual { + #[doc(alias = "hinoko_fw_iso_rx_single_start")] fn start( &self, cycle_match: Option<&[u16; 2]>, @@ -9,7 +10,11 @@ pub trait FwIsoRxSingleExtManual { tags: FwIsoCtxMatchFlag, ) -> Result<(), Error>; + #[doc(alias = "hinoko_fw_iso_rx_single_get_payload")] + #[doc(alias = "get_payload")] fn payload(&self, index: u32) -> &[u8]; + + #[doc(alias = "interrupted")] fn connect_interrupted<F: Fn(&Self, u32, u32, &[u8], u32) + 'static>( &self, f: F, diff --git a/hinoko/src/fw_iso_tx.rs b/hinoko/src/fw_iso_tx.rs index d278874..b7d0b49 100644 --- a/hinoko/src/fw_iso_tx.rs +++ b/hinoko/src/fw_iso_tx.rs @@ -2,6 +2,7 @@ use crate::*; pub trait FwIsoTxExtManual { + #[doc(alias = "hinoko_fw_iso_tx_register_packet")] fn register_packet( &self, tags: FwIsoCtxMatchFlag, @@ -11,8 +12,10 @@ pub trait FwIsoTxExtManual { schedule_interrupt: bool, ) -> Result<(), Error>; + #[doc(alias = "hinoko_fw_iso_tx_start")] fn start(&self, cycle_match: Option<&[u16; 2]>) -> Result<(), Error>; + #[doc(alias = "interrupted")] fn connect_interrupted<F>(&self, f: F) -> SignalHandlerId where F: Fn(&Self, u32, u32, &[u8], u32) + 'static; |