add comments

This commit is contained in:
yggverse 2024-11-05 09:09:54 +02:00
parent 21fc566559
commit 2d2620ffa2

View File

@ -133,6 +133,8 @@ impl Page {
// Actions // Actions
/// Navigate home URL (parsed from current navigation entry)
/// * this method create new history record in memory as defined in `action_page_open` action
pub fn home(&self) { pub fn home(&self) {
if let Some(url) = self.navigation.home_url() { if let Some(url) = self.navigation.home_url() {
// Update with history record // Update with history record
@ -140,6 +142,8 @@ impl Page {
} }
} }
/// Navigate back in history
/// * this method does not create new history record in memory
pub fn history_back(&self) { pub fn history_back(&self) {
if let Some(request) = self.navigation.history_back(true) { if let Some(request) = self.navigation.history_back(true) {
// Update navigation entry // Update navigation entry
@ -150,6 +154,8 @@ impl Page {
} }
} }
/// Navigate forward in history
/// * this method does not create new history record in memory
pub fn history_forward(&self) { pub fn history_forward(&self) {
if let Some(request) = self.navigation.history_forward(true) { if let Some(request) = self.navigation.history_forward(true) {
// Update navigation entry // Update navigation entry
@ -160,10 +166,14 @@ impl Page {
} }
} }
/// Used as API for external reload actions
/// * this method record history to memory buffer by default
pub fn reload(&self) { pub fn reload(&self) {
self.load(true); self.load(true);
} }
/// Main loader for different protocols, that routed by scheme
/// * every protocol has it own (children) method implementation
pub fn load(&self, history: bool) { pub fn load(&self, history: bool) {
/// Global limit to prevent infinitive redirects (ALL protocols) /// Global limit to prevent infinitive redirects (ALL protocols)
/// * every protocol implementation has own value checker, according to specification /// * every protocol implementation has own value checker, according to specification