Improve inline docs (#2460)

Improve inline docs

* improve incorrect event handler return error message

* Improve event handler docs

* document the eval functions

* document spawn and common spawn errors

* fix event handler docs

* add notes about how you use attributes and elements in rsx

* add doc aliases for attributes and events we rename

* add some more aliases for common search terms

* don't doc ignore any public examples in core

* don't ignore public doc examples in ssr

* don't ignore examples in the dioxus package readme

* add a warning when you launch without a renderer enabled

* fix some outdated element docs

* add a bunch of examples to resource

* add notes about desktop events

* add more docs for use_resource

* add on_unimplemented hint to Dependency

* fix some unresolved links

* add examples to each of the router traits

* add not implemented errors for router traits

* add an example to the routable trait

* expand rsx macro docs

* improve memo docs

* update the dioxus readme

* mention dioxus crate features in the docs

* fix a bunch of doc tests

* fix html doc tests

* fix router doc tests

* fix dioxus signals doc tests

* fix dioxus ssr doc tests

* fix use_future example in the hooks cheat sheet

* add a javascript alias for eval

* fix hook explanation values

* remove unused embed-doc-image dependency

packages/html/src/eval.rs

@@ -1,4 +1,5 @@
 #![allow(clippy::await_holding_refcell_ref)]
+#![doc = include_str!("../docs/eval.md")]
 
 use dioxus_core::prelude::*;
 use generational_box::{AnyStorage, GenerationalBox, UnsyncStorage};
@@ -8,7 +9,7 @@ use std::rc::Rc;
 use std::task::{Context, Poll};
 
 /// A struct that implements EvalProvider is sent through [`ScopeState`]'s provide_context function
-/// so that [`use_eval`] can provide a platform agnostic interface for evaluating JavaScript code.
+/// so that [`eval`] can provide a platform agnostic interface for evaluating JavaScript code.
 pub trait EvalProvider {
     fn new_evaluator(&self, js: String) -> GenerationalBox<Box<dyn Evaluator>>;
 }
@@ -47,6 +48,8 @@ pub fn eval_provider() -> EvalCreator {
         as Rc<dyn Fn(&str) -> UseEval>
 }
 
+#[doc = include_str!("../docs/eval.md")]
+#[doc(alias = "javascript")]
 pub fn eval(script: &str) -> UseEval {
     let eval_provider = dioxus_core::prelude::try_consume_context::<Rc<dyn EvalProvider>>()
         // Create a dummy provider that always hiccups when trying to evaluate
@@ -84,7 +87,9 @@ pub fn eval(script: &str) -> UseEval {
     UseEval::new(eval_provider.new_evaluator(script.to_string()))
 }
 
-/// A wrapper around the target platform's evaluator.
+/// A wrapper around the target platform's evaluator that lets you send and receive data from JavaScript spawned by [`eval`].
+///
+#[doc = include_str!("../docs/eval.md")]
 #[derive(Clone, Copy)]
 pub struct UseEval {
     evaluator: GenerationalBox<Box<dyn Evaluator>>,