Mirrors/chatmail-core
1
0
Fork 0
mirror of https://github.com/chatmail/core.git synced 2026-04-18 22:16:30 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rust documentation improvements

Browse Source 
Document all public modules and some methods.

Make some internal public symbols private.
This commit is contained in:
link2xt
2021-08-22 12:26:26 +00:00
committed by Simon Laux
parent f95e1db8e2
commit 2b7bf11b05
44 changed files with 94 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
src/html.rs
View File

@@ -1,11 +1,12 @@
///! # Get message as HTML.
///!
///! Use `Message.has_html()` to check if the UI shall render a
///! corresponding button and `MsgId.get_html()` to get the full message.
///!
///! Even when the original mime-message is not HTML,
///! `MsgId.get_html()` will return HTML -
///! this allows nice quoting, handling linebreaks properly etc.
//! # Get message as HTML.
//!
//! Use `Message.has_html()` to check if the UI shall render a
//! corresponding button and `MsgId.get_html()` to get the full message.
//!
//! Even when the original mime-message is not HTML,
//! `MsgId.get_html()` will return HTML -
//! this allows nice quoting, handling linebreaks properly etc.
use futures::future::FutureExt;
use std::future::Future;
use std::pin::Pin;