sbrl-github/Pepperminty-Wiki
sbrl-github/Pepperminty-Wiki
1
0
Fork 0
mirror of https://github.com/sbrl/Pepperminty-Wiki.git synced 2024-11-23 04:43:00 +00:00
Code Activity

docs: Update apiDoc

Browse source 
As it turns out, we used @apiVersion for things that weren't HTTP API 
routes. In such cases, the recommended directive is @since, not 
@apiVersion
This commit is contained in:
Starbeamrainbowlabs 2022-02-27 16:19:35 +00:00
parent dd0ecaa6f0
commit f4f08d8066
Signed by: sbrl
GPG key ID: 1BE5172E637709C2
7 changed files with 5633 additions and 528 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
build.sh
View file

@ -223,7 +223,7 @@ AWK
task_docs() { task_docs() {
task_begin "Building HTTP API Docs"; task_begin "Building HTTP API Docs";
node_modules/apidoc/bin/apidoc -o './docs/RestApi/' --config apidoc.json -f '.*\.php' -e 'index.php|ModuleApi' node_modules/apidoc/bin/apidoc -o './docs/RestApi/' --config apidoc.json --input . -f '.*\.php' -e 'index.php|ModuleApi'
exit_code="$?"; exit_code="$?";
rm -rf doc/; rm -rf doc/;
task_end "${exit_code}"; task_end "${exit_code}";

6
core/05-functions.php
View file

@ -132,7 +132,7 @@ function glob_recursive($pattern, $flags = 0)
/** /**
* Resolves a relative path against a given base directory. * Resolves a relative path against a given base directory.
* @apiVersion 0.20.0 * @since 0.20.0
* @source https://stackoverflow.com/a/44312137/1460422 * @source https://stackoverflow.com/a/44312137/1460422
* @param string $path The relative path to resolve. * @param string $path The relative path to resolve.
* @param string|null $basePath The base directory to resolve against. * @param string|null $basePath The base directory to resolve against.
@ -205,7 +205,7 @@ function filepath_to_pagename(string $filepath) : string {
/** /**
* Gets the name of the parent page to the specified page. * Gets the name of the parent page to the specified page.
* @apiVersion 0.15.0 * @since 0.15.0
* @package core * @package core
* @param string $pagename The child page to get the parent * @param string $pagename The child page to get the parent
* page name for. * page name for.
@ -699,7 +699,7 @@ function render_editor($editorName) {
* Minifies CSS. Uses simple computationally-cheap optimisations to reduce size. * Minifies CSS. Uses simple computationally-cheap optimisations to reduce size.
* CSS Minification ideas by Jean from catswhocode.com * CSS Minification ideas by Jean from catswhocode.com
* @source http://www.catswhocode.com/blog/3-ways-to-compress-css-files-using-php * @source http://www.catswhocode.com/blog/3-ways-to-compress-css-files-using-php
* @apiVersion 0.20.0 * @since 0.20.0
* @param string $css_str The string of CSS to minify. * @param string $css_str The string of CSS to minify.
* @return string The minified CSS string. * @return string The minified CSS string.
*/ */

2
core/40-page-renderer.php
View file

@ -305,7 +305,7 @@ class page_renderer
* Figures out whether $settings->css is a url, or a string of css. * Figures out whether $settings->css is a url, or a string of css.
* A url is something starting with "protocol://" or simply a "/". * A url is something starting with "protocol://" or simply a "/".
* Before v0.20, this method took no arguments and checked $settings->css directly. * Before v0.20, this method took no arguments and checked $settings->css directly.
* @apiVerion 0.20.0 * @since 0.20.0
* @param string $str The CSS string to check. * @param string $str The CSS string to check.
* @return bool True if it's a url - false if we assume it's a string of css. * @return bool True if it's a url - false if we assume it's a string of css.
*/ */

2
experiments/bktree/JsonStorageBox.php
View file

@ -5,7 +5,7 @@
/** /**
* Resolves a relative path against a given base directory. * Resolves a relative path against a given base directory.
* @apiVersion 0.20.0 * @since 0.20.0
* @source https://stackoverflow.com/a/44312137/1460422 * @source https://stackoverflow.com/a/44312137/1460422
* @param string $path The relative path to resolve. * @param string $path The relative path to resolve.
* @param string|null $basePath The base directory to resolve against. * @param string|null $basePath The base directory to resolve against.

2
modules/page-list.php
View file

@ -239,7 +239,7 @@ register_module([
/** /**
* Gets a list of all the tags currently used across the wiki. * Gets a list of all the tags currently used across the wiki.
* @package page-list * @package page-list
* @apiVersion 0.15.0 * @since 0.15.0
* @return string[] A list of all unique tags present on all pages across the wiki. * @return string[] A list of all unique tags present on all pages across the wiki.
*/ */
function get_all_tags() function get_all_tags()

6145
package-lock.json generated
View file

File diff suppressed because it is too large Load diff

2
package.json
View file

@ -20,7 +20,7 @@
}, },
"homepage": "https://github.com/sbrl/Pepperminty-Wiki#readme", "homepage": "https://github.com/sbrl/Pepperminty-Wiki#readme",
"devDependencies": { "devDependencies": {
"apidoc": "^0.17.7", "apidoc": "^0.50.4",
"nightdocs": "^1.1.0" "nightdocs": "^1.1.0"
}, },
"docpress": { "docpress": {