|
69 | 69 | //!
|
70 | 70 | //! The single-use macros are the most concise option, but also a rather
|
71 | 71 | //! special-case solution.
|
72 |
| -//! `progmem_str` gives you are very temporary `&str` to an ad-hoc loaded |
| 72 | +//! [`progmem_str`](crate::progmem_str) gives you are very temporary `&str` |
| 73 | +//! to an ad-hoc loaded |
73 | 74 | //! progmem string, so you can only pass it to a function call and you need
|
74 | 75 | //! enough RAM to store it.
|
75 | 76 | //! On the other hand, [`progmem_display`](crate::progmem_display) gives you
|
|
82 | 83 | //!
|
83 | 84 | //! # Examples
|
84 | 85 | //!
|
85 |
| -//! Using [`PmString`] directly via the [`progmem`] macro: |
| 86 | +//! Using [`PmString`] directly via the [`progmem`](crate::progmem) macro: |
86 | 87 | //!
|
87 | 88 | //! ```rust
|
88 | 89 | //! # use std::iter::FromIterator;
|
|
125 | 126 | //! # assert_eq!("Hello 大賢者", writer.0);
|
126 | 127 | //! ```
|
127 | 128 | //!
|
128 |
| -//! Using the special literal in-line string macros [`progmem_str`] |
129 |
| -//! (yielding a `&str`) and [`progmem_display`] (yielding some |
130 |
| -//! `impl Display + uDisplay`): |
| 129 | +//! Using the special literal in-line string macros [`progmem_str`](crate::progmem_str) |
| 130 | +//! (yielding a `&str`) and [`progmem_display`](crate::progmem_display) |
| 131 | +//! (yielding some `impl Display + uDisplay`): |
131 | 132 | //!
|
132 | 133 | //! ```rust
|
133 | 134 | //! use avr_progmem::progmem_str as F;
|
@@ -397,7 +398,7 @@ pub struct PmString<const N: usize> {
|
397 | 398 | impl<const N: usize> PmString<N> {
|
398 | 399 | /// Creates a new byte array from the given string
|
399 | 400 | ///
|
400 |
| - /// You are encouraged to use the [`progmem`] macro instead. |
| 401 | + /// You are encouraged to use the [`progmem`](crate::progmem) macro instead. |
401 | 402 | ///
|
402 | 403 | /// # Safety
|
403 | 404 | ///
|
@@ -541,7 +542,7 @@ impl<'a, const N: usize> Iterator for PmChars<'a, N> {
|
541 | 542 | /// Similar to the C marco, this will load the full string into RAM at once
|
542 | 543 | /// and thus the string should be of limited size, to not exceed the space
|
543 | 544 | /// available in RAM.
|
544 |
| -/// Also see the [progmem_display] macro which does not have this limitation. |
| 545 | +/// Also see the [progmem_display](crate::progmem_display) macro which does not have this limitation. |
545 | 546 | ///
|
546 | 547 | /// This macro allows to conveniently put a literal string into progmem
|
547 | 548 | /// right where it is used.
|
|
0 commit comments