autocompile documentation on each commit
only tested this once by the way minor formatting changes in icon.js
This commit is contained in:
parent
bf646d10ba
commit
837dffc4dc
|
@ -0,0 +1,22 @@
|
||||||
|
name: "[icondumper2] autobuild"
|
||||||
|
|
||||||
|
on: [push]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
documentation:
|
||||||
|
name: Compile documentation via JSDoc
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Clone repository
|
||||||
|
uses: actions/checkout@main
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- name: Install node.js
|
||||||
|
uses: actions/setup-node@main
|
||||||
|
- name: Compile documentation with JSDoc
|
||||||
|
run: npx jsdoc ./icon.js -d ./documentation -R ./README.md
|
||||||
|
- name: Upload Artifacts
|
||||||
|
uses: 'actions/upload-artifact@main'
|
||||||
|
with:
|
||||||
|
name: JSDoc-compiled Documentation
|
||||||
|
path: './documentation/*'
|
6
icon.js
6
icon.js
|
@ -15,7 +15,7 @@ const ICONJS_VERSION = "0.6.0";
|
||||||
* @augments DataView
|
* @augments DataView
|
||||||
* @constructor
|
* @constructor
|
||||||
* @param {ArrayBuffer} buffer ArrayBuffer to base DataView from.
|
* @param {ArrayBuffer} buffer ArrayBuffer to base DataView from.
|
||||||
* @returns {Object.<string, function>}
|
* @returns {Object.<string, function(number): number>}
|
||||||
* @access protected
|
* @access protected
|
||||||
*/
|
*/
|
||||||
class yellowDataReader extends DataView {
|
class yellowDataReader extends DataView {
|
||||||
|
@ -33,7 +33,7 @@ class yellowDataReader extends DataView {
|
||||||
* @param {number} i Indice offset.
|
* @param {number} i Indice offset.
|
||||||
* @returns {number}
|
* @returns {number}
|
||||||
*/
|
*/
|
||||||
u32le(i){return super.getUint32(i, 1)};
|
u32le(i){return super.getUint32(i, 1)};
|
||||||
/** Floating-point 32-bit, Little Endian.
|
/** Floating-point 32-bit, Little Endian.
|
||||||
* @param {number} i Indice offset.
|
* @param {number} i Indice offset.
|
||||||
* @returns {number}
|
* @returns {number}
|
||||||
|
@ -87,7 +87,7 @@ function setStrictness(value) {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Converts a texture format to a generalized texture type character.
|
* Converts a texture format to a generalized texture type character.
|
||||||
* @param {number} input - texture format
|
* @param {number} i - texture format
|
||||||
* @returns {string} U: uncompressed, N: none, C: compressed
|
* @returns {string} U: uncompressed, N: none, C: compressed
|
||||||
* @access protected
|
* @access protected
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue