Skip to content

Commit

Permalink
Fixing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ryan-summers committed Jul 7, 2023
1 parent 05715f3 commit deb381e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .cargo/config
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[target.'cfg(all(target_arch = "arm", target_os = "none"))']
runner = "probe-run --chip STM32H743ZITx --speed 30000"
#runner = "probe-run --chip STM32H743ZITx --speed 30000"
# runner = "gdb-multiarch -q -x openocd.gdb"
runner = "probe-rs-cli download --chip STM32H743ZITx"
rustflags = [
"-C", "link-arg=-Tlink.x",
"-C", "link-arg=--nmagic",
Expand Down
16 changes: 9 additions & 7 deletions ad9959/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,16 +97,10 @@ pub enum Error {
}

impl<I: Interface> Ad9959<I> {
/// Construct and initialize the DDS.
/// Constructor.
///
/// Args:
/// * `interface` - An interface to the DDS.
/// * `reset_pin` - A pin connected to the DDS reset input.
/// * `io_update` - A pin connected to the DDS io_update input.
/// * `delay` - A delay implementation for blocking operation for specific amounts of time.
/// * `desired_mode` - The desired communication mode of the interface to the DDS.
/// * `clock_frequency` - The clock frequency of the reference clock input.
/// * `multiplier` - The desired clock multiplier for the system clock. This multiplies
/// `clock_frequency` to generate the system clock.
pub fn new(interface: I, clock_frequency: f32) -> Self {
Self {
Expand All @@ -117,6 +111,14 @@ impl<I: Interface> Ad9959<I> {
}
}

/// Initialize the DDS
///
/// # Args
/// * `reset_pin` - A pin connected to the DDS reset input.
/// * `io_update` - A pin connected to the DDS io_update input.
/// * `delay` - A delay implementation for blocking operation for specific amounts of time.
/// * `desired_mode` - The desired communication mode of the interface to the DDS.
/// * `multiplier` - The desired clock multiplier for the system clock. This multiplies
pub fn initialize(
&mut self,
reset_pin: &mut impl OutputPin,
Expand Down

0 comments on commit deb381e

Please sign in to comment.