suggest-similar: update apidoc comment

This commit is contained in:
Starbeamrainbowlabs 2020-05-23 12:56:46 +01:00
parent 04bb67f505
commit 908f14f92c
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
1 changed files with 14 additions and 8 deletions

View File

@ -9,20 +9,26 @@ register_module([
"code" => function() {
global $settings;
/**
* @api {get} ?action=raw&page={pageName} Get the raw source code of a page
* @apiName RawSource
* @api {get} ?action=suggest-similar&page={pageName} Get similar page suggestions
* @apiName SuggestSimilar
* @apiGroup Page
* @apiPermission Anonymous
*
* @apiParam {string} page The page to return the source of.
* @apiParam {string} page The page to return suggestions for.
*/
/*
* ██████ █████ ██ ██
* ██ ██ ██ ██ ██ ██
* ██████ ███████ ██ ██
* ██ ██ ██ ██ ██ ███ ██
* ██ ██ ██ ██ ███ ███
* ███████ ██ ██ ██████ ██████ ███████ ███████ ████████
* ██ ██ ██ ██ ██ ██ ██ ██
* ███████ ██ ██ ██ ███ ██ ███ █████ ███████ ██
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
* ███████ ██████ ██████ ██████ ███████ ███████ ██
*
* ███████ ██ ███ ███ ██ ██ █████ ██████
* ██ ██ ████ ████ ██ ██ ██ ██ ██ ██
* ███████ ██ ██ ████ ██ ██ ██ ███████ ██████
* ██ ██ ██ ██ ██ ██ ██ ██ ██ ██ ██
* ███████ ██ ██ ██ ██ ███████ ██ ██ ██ ██
*/
add_action("suggest-similar", function() {
global $pageindex, $env;