From a3330829cb258a8c529a071be664af04cbae25e0 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Sun, 10 Feb 2019 23:18:34 +0000 Subject: [PATCH] Bump module versions & go over documentation comments --- modules/action-hash.php | 9 +++------ modules/feature-comments.php | 3 ++- modules/feature-interwiki-links.php | 6 +++++- modules/feature-recent-changes.php | 2 +- modules/feature-redirect.php | 5 +++-- modules/feature-search.php | 1 + 6 files changed, 15 insertions(+), 11 deletions(-) diff --git a/modules/action-hash.php b/modules/action-hash.php index 748227e..30b35b8 100644 --- a/modules/action-hash.php +++ b/modules/action-hash.php @@ -28,19 +28,16 @@ register_module([ add_action("hash", function() { global $settings; - if(!isset($_GET["string"])) - { + if(!isset($_GET["string"])) { http_response_code(422); exit(page_renderer::render_main("Missing parameter", "

The GET parameter string must be specified.

It is strongly recommended that you utilise this page via a private or incognito window in order to prevent your password from appearing in your browser history.

")); } - else if(!empty($_GET["raw"])) - { + else if(!empty($_GET["raw"])) { header("content-type: text/plain"); exit(hash_password($_GET["string"])); } - else - { + else { exit(page_renderer::render_main("Hashed string", "

Algorithm: $settings->password_algorithm

\n

" . $_GET["string"] . " → " . hash_password($_GET["string"]) . "

")); } }); diff --git a/modules/feature-comments.php b/modules/feature-comments.php index 5450d9a..e9dc398 100644 --- a/modules/feature-comments.php +++ b/modules/feature-comments.php @@ -1,7 +1,7 @@ "Page Comments", - "version" => "0.3.1", + "version" => "0.3.2", "author" => "Starbeamrainbowlabs", "description" => "Adds threaded comments to the bottom of every page.", "id" => "feature-comments", @@ -369,6 +369,7 @@ function find_comment($comment_data, $comment_id) /** * Deletes the first comment found with the specified id. + * @package feature-comments * @param array $comment_data An array of threaded comments to delete the comment from. * @param string $target_id The id of the comment to delete. * @return bool Whether the comment was found and deleted or not. diff --git a/modules/feature-interwiki-links.php b/modules/feature-interwiki-links.php index 0ddfe00..e00c37d 100644 --- a/modules/feature-interwiki-links.php +++ b/modules/feature-interwiki-links.php @@ -1,7 +1,7 @@ "Interwiki links", - "version" => "0.1", + "version" => "0.1.1", "author" => "Starbeamrainbowlabs", "description" => "Adds interwiki link support. Set the interwiki_index_location setting at an index file to activate support.", "id" => "feature-interwiki-links", @@ -71,6 +71,7 @@ function interwiki_index_update() { /** * Parses an interwiki pagename into it's component parts. + * @package interwiki-links * @param string $interwiki_pagename The interwiki pagename to parse. * @return string[] An array containing the parsed components of the interwiki pagename, in the form ["prefix", "page_name"]. */ @@ -84,6 +85,7 @@ function interwiki_pagename_parse($interwiki_pagename) { /** * Resolves an interwiki pagename to the associated * interwiki definition object. + * @package interwiki-links * @param string $interwiki_pagename An interwiki pagename. Should be in the form "prefix:page name". * @return stdClass The interwiki definition object. */ @@ -106,6 +108,7 @@ function interwiki_pagename_resolve($interwiki_pagename) { } /** * Converts an interwiki pagename into a url. + * @package interwiki-links * @param string $interwiki_pagename The interwiki pagename (in the form "prefix:page name") * @return string A url that points to the specified interwiki page. */ @@ -125,6 +128,7 @@ function interwiki_get_pagename_url($interwiki_pagename) { /** * Returns whether a given pagename is an interwiki link or not. * Note that this doesn't guarantee that it's a _valid_ interwiki link - only that it looks like one :P + * @package interwiki-links * @param string $pagename The page name to check. * @return boolean Whether the given page name is an interwiki link or not. */ diff --git a/modules/feature-recent-changes.php b/modules/feature-recent-changes.php index 073280c..817c699 100644 --- a/modules/feature-recent-changes.php +++ b/modules/feature-recent-changes.php @@ -1,7 +1,7 @@ "Recent Changes", - "version" => "0.4", + "version" => "0.5", "author" => "Starbeamrainbowlabs", "description" => "Adds recent changes. Access through the 'recent-changes' action.", "id" => "feature-recent-changes", diff --git a/modules/feature-redirect.php b/modules/feature-redirect.php index 3b8ec98..f422bfe 100644 --- a/modules/feature-redirect.php +++ b/modules/feature-redirect.php @@ -18,8 +18,9 @@ register_module([ /** * Updates the metadata associated with redirects in the pageindex entry * specified utilising the provided page content. - * @param object $index_entry The page index entry object to update. - * @param string $pagedata The page content to operate on. + * @package redirect + * @param object $index_entry The page index entry object to update. + * @param string $pagedata The page content to operate on. */ function update_redirect_metadata(&$index_entry, &$pagedata) { $matches = []; diff --git a/modules/feature-search.php b/modules/feature-search.php index 5b5fea7..f06a9cc 100644 --- a/modules/feature-search.php +++ b/modules/feature-search.php @@ -477,6 +477,7 @@ window.addEventListener("load", function(event) { /** * Holds a collection to methods to manipulate various types of search index. + * @package search */ class search {