docs: Fix docs (#152)

Author: LeoPatOZ

.github/workflows/check.yml

@@ -86,6 +86,27 @@ jobs:
       - name: Clippy Check
         run: cargo clippy --all-targets --all-features -- -D warnings -D clippy::pedantic
 
+  cargo-doc:
+    name: Cargo doc
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Harden the runner (Audit all outbound calls)
+        uses: step-security/harden-runner@f4a75cfd619ee5ce8d5b864b0d183aff3c69b55a # v2.13.1
+        with:
+          egress-policy: audit
+
+      - name: Fetch Repository
+        uses: actions/checkout@ff7abcd0c3c05ccf6adc123a8cd1fd4fb30fb493
+
+      - name: Install stable toolchain
+        uses: actions-rust-lang/setup-rust-toolchain@1780873c7b576612439a134613cc4cc74ce5538c # v1.15.2
+
+      - name: Rustdoc Check
+        run: cargo doc --no-deps --all-features
+        env:
+          RUSTDOCFLAGS: -D warnings
+
   typos-cli:
     name: typos
     runs-on: ubuntu-latest

src/event_scanner/scanner/mod.rs

@@ -219,7 +219,8 @@ impl EventScannerBuilder<Unspecified> {
     /// EventScannerBuilder::sync().from_latest(10);
     /// ```
     ///
-    /// See the [sync module documentation](sync) for details on each mode.
+    /// See [`from_block`](EventScannerBuilder::from_block) and
+    /// [`from_latest`](EventScannerBuilder::from_latest) for details on each mode.
     #[must_use]
     pub fn sync() -> EventScannerBuilder<Synchronize> {
         EventScannerBuilder::default()
@@ -319,7 +320,7 @@ impl EventScannerBuilder<Unspecified> {
     /// [subscribe]: EventScanner::subscribe
     /// [start]: EventScanner::start
     /// [sync_from_latest]: EventScannerBuilder::from_latest
-    /// [reorg]: ScannerStatus::ReorgDetected
+    /// [reorg]: crate::ScannerStatus::ReorgDetected
     #[must_use]
     pub fn latest(count: usize) -> EventScannerBuilder<LatestEvents> {
         EventScannerBuilder::<LatestEvents>::new(count)
@@ -367,7 +368,7 @@ impl EventScannerBuilder<SyncFromBlock> {
 impl<M> EventScannerBuilder<M> {
     /// Connects to the provider via WebSocket.
     ///
-    /// Final builder method: consumes the builder and returns the built [`HistoricEventScanner`].
+    /// Final builder method: consumes the builder and returns the built [`EventScanner`].
     ///
     /// # Errors
     ///
@@ -379,7 +380,7 @@ impl<M> EventScannerBuilder<M> {
 
     /// Connects to the provider via IPC.
     ///
-    /// Final builder method: consumes the builder and returns the built [`HistoricEventScanner`].
+    /// Final builder method: consumes the builder and returns the built [`EventScanner`].
     ///
     /// # Errors
     ///
@@ -394,7 +395,7 @@ impl<M> EventScannerBuilder<M> {
 
     /// Connects to an existing provider.
     ///
-    /// Final builder method: consumes the builder and returns the built [`HistoricEventScanner`].
+    /// Final builder method: consumes the builder and returns the built [`EventScanner`].
     ///
     /// # Errors
     ///

src/event_scanner/scanner/sync/mod.rs

@@ -96,8 +96,8 @@ impl EventScannerBuilder<Synchronize> {
     ///   confirmations. On reorg, emits [`ScannerStatus::ReorgDetected`][reorg], adjusts the next
     ///   confirmed window (possibly re-emitting confirmed portions), and continues streaming.
     ///
-    /// [subscribe]: from_latest::SyncFromLatestEventScanner::subscribe
-    /// [start]: from_latest::SyncFromLatestEventScanner::start
+    /// [subscribe]: crate::EventScanner::subscribe
+    /// [start]: crate::event_scanner::EventScanner::start
     /// [reorg]: crate::types::ScannerStatus::ReorgDetected
     /// [switch_to_live]: crate::types::ScannerStatus::SwitchingToLive
     #[must_use]
@@ -201,8 +201,8 @@ impl EventScannerBuilder<Synchronize> {
     ///   [`ScannerStatus::ReorgDetected`][reorg], adjusts the next confirmed window (possibly
     ///   re-emitting confirmed portions), and continues streaming.
     ///
-    /// [subscribe]: from_latest::SyncFromLatestEventScanner::subscribe
-    /// [start]: from_latest::SyncFromLatestEventScanner::start
+    /// [subscribe]: crate::EventScanner::subscribe
+    /// [start]: crate::event_scanner::EventScanner::start
     /// [reorg]: crate::types::ScannerStatus::ReorgDetected
     /// [switch_to_live]: crate::types::ScannerStatus::SwitchingToLive
     #[must_use]