docs: Update apiDoc

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
pull/230/head
Starbeamrainbowlabs 11 months ago
parent dd0ecaa6f0
commit f4f08d8066
Signed by: sbrl
GPG Key ID: 1BE5172E637709C2
  1. 2
      build.sh
  2. 6
      core/05-functions.php
  3. 2
      core/40-page-renderer.php
  4. 2
      experiments/bktree/JsonStorageBox.php
  5. 2
      modules/page-list.php
  6. 6727
      package-lock.json
  7. 2
      package.json

@ -223,7 +223,7 @@ AWK
task_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="$?";
rm -rf doc/;
task_end "${exit_code}";

@ -132,7 +132,7 @@ function glob_recursive($pattern, $flags = 0)
/**
* Resolves a relative path against a given base directory.
* @apiVersion 0.20.0
* @since 0.20.0
* @source https://stackoverflow.com/a/44312137/1460422
* @param string $path The relative path to resolve.
* @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.
* @apiVersion 0.15.0
* @since 0.15.0
* @package core
* @param string $pagename The child page to get the parent
* page name for.
@ -699,7 +699,7 @@ function render_editor($editorName) {
* Minifies CSS. Uses simple computationally-cheap optimisations to reduce size.
* CSS Minification ideas by Jean from catswhocode.com
* @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.
* @return string The minified CSS string.
*/

@ -305,7 +305,7 @@ class page_renderer
* Figures out whether $settings->css is a url, or a string of css.
* A url is something starting with "protocol://" or simply a "/".
* 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.
* @return bool True if it's a url - false if we assume it's a string of css.
*/

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

@ -239,7 +239,7 @@ register_module([
/**
* Gets a list of all the tags currently used across the wiki.
* @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.
*/
function get_all_tags()

6727
package-lock.json generated

File diff suppressed because it is too large Load Diff

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

Loading…
Cancel
Save