1
0
mirror of https://github.com/MontFerret/ferret.git synced 2025-06-23 00:28:10 +02:00

Rewrite comments, closing #118

This commit is contained in:
3timeslazy
2018-10-14 20:06:27 +03:00
committed by Tim Voronov
parent 5db8df55db
commit 6df08a60cb
117 changed files with 715 additions and 878 deletions

View File

@ -2,20 +2,19 @@ package html
import (
"context"
"github.com/MontFerret/ferret/pkg/html/dynamic"
"github.com/MontFerret/ferret/pkg/runtime/core"
"github.com/MontFerret/ferret/pkg/runtime/values"
)
/*
* Navigates a document forward within its navigation history.
* The operation blocks the execution until the page gets loaded.
* If the history is empty, the function returns FALSE.
* @param doc (Document) - Target document.
* @param entry (Int, optional) - Optional value indicating how many pages to skip. Default 1.
* @param timeout (Int, optional) - Optional timeout. Default is 5000.
* @returns (Boolean) - Returns TRUE if history exists and the operation succeeded, otherwise FALSE.
*/
// NavigateForward navigates a document forward within its navigation history.
// The operation blocks the execution until the page gets loaded.
// If the history is empty, the function returns FALSE.
// @param doc (Document) - Target document.
// @param entry (Int, optional) - Optional value indicating how many pages to skip. Default 1.
// @param timeout (Int, optional) - Optional timeout. Default is 5000.
// @returns (Boolean) - Returns TRUE if history exists and the operation succeeded, otherwise FALSE.
func NavigateForward(_ context.Context, args ...core.Value) (core.Value, error) {
err := core.ValidateArgs(args, 1, 3)