Skip to content

Commit

Permalink
docs: removed old stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
MrIsaacs committed Oct 25, 2017
1 parent 31ccf4b commit 7a2f05f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 21 deletions.
14 changes: 3 additions & 11 deletions data/docs.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
{
"index" : {
"2" : 0,
"1" : 1
"1" : 0
},
"data" : [{
"id" : "2",
"link" : "docs",
"title" : "Home",
"short" : "A JavaScript framework manager.",
"body" : "More coming soon...\n| Classes | Members | Methods |\n|:-|:-:|:-:|\n| <a href=\"#docs/2\">Manic</a> | version | next() |\n| | | prev() |\n# manic.js\nMain project file.\n> Version: 2.1.1<br> Author: Ivan Ilic<br> Source: manic.js, line 1\n",
"date" : "Apr 13, 2017 21:14:00"
}, {
"id" : "1",
"link" : "docs",
"title" : "Manic",
"short" : "Main class for managing different javascript frameworks.",
"body" : "public class | version 2.2.0 | source\n\nJust another JavaScript library.\n# *Constructor Summary*\n## **Public Constructor**\n\n---\n| | | |\n|-:|:-|:-:|\n| public | `constructor()` Initialize events, requests and services. | | |\n# *Member Summary*\n## **Public Members**\n\n---\n| | |\n|-:|:-|:-:|\n| public | `[services]: Service` Iterable collection of services. | |\n| public get | `scriptCollection: string` Iterate through services and call loadServices for each service. | since 2.0.0 |\n| public get | `version: string: *` Returns current version number. | since 2.0.0 |\n## **Private Members**\n\n---\n| | | |\n|-:|:-|:-:|\n| private | `_contextMgr: Object` | |\n| private | `_events: Object` | |\n| private | `_first: boolean` Use to indicate wheter the Service iterator is running for the first time. | |\n| private | `_request: Object` | |\n| private | `_response: Object` | |\n| private | `_version: Object` | |\n# *Method Summary*\n## **Public Methods**\n\n---\n| | | |\n|-:|:-|:-:|\n| public | `addScript(response: Object, script: *)` | since 2.2.0 |\n| public | `getContent(site: *)` Deprecated! Use _render_ instead. | since 2.1.0 |\n| public | `insertScript(response: *, script: *)` Deprecated! Use _addScript_ instead. | since 2.0.0 |\n| public | `isArray(e: *): boolean` | since 2.0.0 |\n| public | `isPromise(e: *): boolean` | since 2.0.0 |\n| public | `loadJS(url: string): *` | since 2.0.0 |\n| public | `loadJSON(url: *): *` | since 2.0.0 |\n| public | `loadScripts(service: Service)` This method is deprecated. | since 2.0.0 |\n| public | `loadServices(service: Service): *` Load service and initialize if function init exists. | since 2.2.0 |\n| public | `next(db: Object, key: string): Object` | since 1.1.2 |\n| public | `off(eventName: string, fn: function)` Deletes a function with a given name an its function. | |\n| public | `on(eventName: string, fn: function)` Creates a function on the fly, which can be invoced by the trigger function. | |\n| public | `prev(db: Object, key: string): Object` | since 1.1.2 |\n| public | `render(site: *)` | since 2.2.0 |\n| public | `retrigger(eventName: string, data: Object)` Triggers eventName as a function and assigns data as parameter. | |\n# *Public Constructors*\n## **public:**\n\n---\n`constructor()`\n\nInitialize events, requests and services. Events\n# *Public Members*\n## **public:**\n\n---\n`[services]: Service`\n\nIterable collection of services. Each service contains the _url_ and _init_ function, which is called in _loadServices_.\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| framework | `Service` | optional | The framework of your desire. |\n| markdown | `Service` | optional | The markdown of your wish. |\n| route | `Service` | optional | The route service of your use. |\n\n---\n`scriptCollection: string`\n\nIterate through services and call _loadServices_ for each service.\n## _**Return**_:\n\n| | |\n|-:|:-|\n| `string` | Injects scrtipts for each needed service at the bottom of the document, before body ends. |\n## _**TODO:**_\n\nredefine scriptCollection\n\n---\n`version: string: *`\n\nReturns current version number.\n## _**Return**_:\n\n| | |\n|:-|:-|\n| `string` | Returns the version number as **major.minor.patch**. |\n# *Private Members*\n\n---\n`_contextMgr: Object`\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| container | `Object` | | |\n| content | `Object` | | |\n\n---\n`_events: Object`\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| eventName | `string` | | |\n| fn | `function` | | |\n\n---\n`_first: boolean`\n\nUse to indicate wheter the Service iterator is running for the first time. If so, then initialize the services into an item list.\n\n---\n`_request: Object`\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| id | `number` | default: 1 | Id of requested article. |\n| type | `string` | default: info | Defines what _type_ of data is requested. _type_ can be _info or list_. |\n| slug | `string` | default: home | Defines what page is requested to be rendered. |\n## _**TODO:**_\n\nchange request properties\n\n---\n`_response: Object`\n## _**TODO:**_\n\nHandle response object via member.\n\n---\n`_version: Object`\n## _**Properties:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| major | `number` | | |\n| minor | `number` | | |\n| patch | `number` | | |\n# *Public Methods*\n\n---\nsince 2.2.0\n`addScript(response: Object, script: *)`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| response | `Object` | | |\n| script | `*` | | !NOT USED! Passed over parameter doesn't do anything. |\n\n## _**See:**_ [Stackoverflow](https://stackoverflow.com/questions/950087/how-do-i-include-a-javascript-file-in-another-javascript-file/950146#950146)\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.1.0 `getContent(site: *)`\n\nDeprecated! Use _render_ instead.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| site | `*` | | |\n\n---\nsince 2.0.0 `insertScript(response: *, scrtipt: *)`\n\nDeprecated! Use _addScript_ instead.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| response | `*` | | |\n| script | `*` | | |\n\n---\nsince 2.0.0 `isArray(e: *): boolean`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| e | `*` | | |\n## _**Return:**_ `boolean`\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `isPromise(e: *): boolean`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| e | `*` | | |\n## _**Return:**_ `boolean`\n## _**See:**_ [Stackoverflow](https://stackoverflow.com/questions/27746304/how-do-i-tell-if-an-object-is-a-promise/45762727#45762727)\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `loadJS(url: string): *`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| url | `string` | | URL is taken from _Service_ to request for its script. |\n## _**Return:**_ `*`\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `loadJSON(url: *): *`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| url | `*` | | |\n## _**Return:**_ `*`\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `loadScripts(service: Service)`\n\nDeprecated! Use _loadServices_ instead.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| service | `Service` | | |\n## _**Return:**_ `*`\n\n---\nsince 2.2.0 `loadServices(service: Service): *`\n\nLoad _service_ and initialize if function _init_ exists. If _service.url_ is an array of URL's, then load each URL, before calling _init_.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| service | `Service` | | |\n## _**Return:**_ `*`\n\n---\nsince 1.1.2 `next(db: Object, key: string): Object`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| db | `Object` | | |\n| key | `string` | | |\n## _**Return:**_ `Object (nullable: true)` Returns the next data payload of given key.\n\n---\n`off(eventName: string, fn: function)`\n\nDeletes a function with a given name an its function. It can not be triggered afterwards.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| eventName | `string` | | _eventName_ to be deleted. |\n| fn | `function` | optional | Function which will be deleted with respect to _eventName_. |\n## _**TODO:**_ events must also be mutable\n\n---\n`on(eventName: string, fn: function)`\n\nCreates a function on the fly, which can be invoced by the trigger function.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| eventName | `string` | | Functionname to be created |\n| fn | `function` | optional | Function which will be called with respect to the eventName. |\n\n---\nsince 1.1.2 `prev(db: Object, key: string): Object`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| db | `Object` | | |\n| key | `string` | | |\n## _**Return:**_ `Object (nullable: true)` Returns the previous data payload of given key.\n\n---\nsince 2.2.0 `render(site: *)`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| site | `*` | | |\n## _**TODO:**_ template should be configured in settings\n`render` use _mootools_ selector to get a desired element. These functions must be provided hy the `[services]` middleware stack for a given service.\n\n---\n`trigger(eventName: string, data: Object)`\n\nTriggers eventName as a function and assigns data as parameter.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| site | `*` | | |\n## _**TODO:**_ description of data is needed.\n\n---\n",
"date" : ["2017-04-13T21:14:00+02:00", "2017-10-25T02:21:45+02:00"]
"body" : "public class | version 2.2.0 | source\n\nJust another JavaScript library.\n# *Constructor Summary*\n## **Public Constructor**\n\n---\n| | | |\n|-:|:-|:-:|\n| public | `constructor()` Initialize events, requests and services. | | |\n# *Member Summary*\n## **Public Members**\n\n---\n| | |\n|-:|:-|:-:|\n| public | `[services]: Service` Iterable collection of services. | |\n| public get | `scriptCollection: string` Iterate through services and call loadServices for each service. | since 2.0.0 |\n| public get | `version: string: *` Returns current version number. | since 2.0.0 |\n## **Private Members**\n\n---\n| | | |\n|-:|:-|:-:|\n| private | `_contextMgr: Object` | |\n| private | `_events: Object` | |\n| private | `_first: boolean` Use to indicate wheter the Service iterator is running for the first time. | |\n| private | `_request: Object` | |\n| private | `_response: Object` | |\n| private | `_version: Object` | |\n# *Method Summary*\n## **Public Methods**\n\n---\n| | | |\n|-:|:-|:-:|\n| public | `addScript(response: Object, script: *)` | since 2.2.0 |\n| public | `getContent(site: *)` Deprecated! Use _render_ instead. | since 2.1.0 |\n| public | `insertScript(response: *, script: *)` Deprecated! Use _addScript_ instead. | since 2.0.0 |\n| public | `isArray(e: *): boolean` | since 2.0.0 |\n| public | `isPromise(e: *): boolean` | since 2.0.0 |\n| public | `loadJS(url: string): *` | since 2.0.0 |\n| public | `loadJSON(url: *): *` | since 2.0.0 |\n| public | `loadScripts(service: Service)` This method is deprecated. | since 2.0.0 |\n| public | `loadServices(service: Service): *` Load service and initialize if function init exists. | since 2.2.0 |\n| public | `next(db: Object, key: string): Object` | since 1.1.2 |\n| public | `off(eventName: string, fn: function)` Deletes a function with a given name an its function. | |\n| public | `on(eventName: string, fn: function)` Creates a function on the fly, which can be invoced by the trigger function. | |\n| public | `prev(db: Object, key: string): Object` | since 1.1.2 |\n| public | `render(site: *)` | since 2.2.0 |\n| public | `retrigger(eventName: string, data: Object)` Triggers eventName as a function and assigns data as parameter. | |\n# *Public Constructors*\n## **public:**\n\n---\n`constructor()`\n\nInitialize events, requests and services. Events\n# *Public Members*\n## **public:**\n\n---\n`[services]: Service`\n\nIterable collection of services. Each service contains the _url_ and _init_ function, which is called in _loadServices_.\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| framework | `Service` | optional | The framework of your desire. |\n| markdown | `Service` | optional | The markdown of your wish. |\n| route | `Service` | optional | The route service of your use. |\n\n---\n`scriptCollection: string`\n\nIterate through services and call _loadServices_ for each service.\n## _**Return**_:\n\n| | |\n|-:|:-|\n| `string` | Injects scrtipts for each needed service at the bottom of the document, before body ends. |\n## _**TODO:**_\n\nredefine scriptCollection\n\n---\n`version: string: *`\n\nReturns current version number.\n## _**Return**_:\n\n| | |\n|:-|:-|\n| `string` | Returns the version number as **major.minor.patch**. |\n# *Private Members*\n\n---\n`_contextMgr: Object`\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| container | `Object` | | |\n| content | `Object` | | |\n\n---\n`_events: Object`\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| eventName | `string` | | |\n| fn | `function` | | |\n\n---\n`_first: boolean`\n\nUse to indicate wheter the Service iterator is running for the first time. If so, then initialize the services into an item list.\n\n---\n`_request: Object`\n## _**Properties:**_\n\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| id | `number` | default: 1 | Id of requested article. |\n| type | `string` | default: info | Defines what _type_ of data is requested. _type_ can be _info or list_. |\n| slug | `string` | default: home | Defines what page is requested to be rendered. |\n## _**TODO:**_\n\nchange request properties\n\n---\n`_response: Object`\n## _**TODO:**_\n\nHandle response object via member.\n\n---\n`_version: Object`\n## _**Properties:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| major | `number` | | |\n| minor | `number` | | |\n| patch | `number` | | |\n# *Public Methods*\n\n---\nsince 2.2.0\n`addScript(response: Object, script: *)`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| response | `Object` | | |\n| script | `*` | | !NOT USED! Passed over parameter doesn't do anything. |\n\n## _**See:**_ [Stackoverflow](https://stackoverflow.com/questions/950087/how-do-i-include-a-javascript-file-in-another-javascript-file/950146#950146)\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.1.0 `getContent(site: *)`\n\nDeprecated! Use _render_ instead.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| site | `*` | | |\n\n---\nsince 2.0.0 `insertScript(response: *, scrtipt: *)`\n\nDeprecated! Use _addScript_ instead.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| response | `*` | | |\n| script | `*` | | |\n\n---\nsince 2.0.0 `isArray(e: *): boolean`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| e | `*` | | |\n## _**Return:**_ `boolean`\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `isPromise(e: *): boolean`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| e | `*` | | |\n## _**Return:**_ `boolean`\n## _**See:**_ [Stackoverflow](https://stackoverflow.com/questions/27746304/how-do-i-tell-if-an-object-is-a-promise/45762727#45762727)\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `loadJS(url: string): *`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| url | `string` | | URL is taken from _Service_ to request for its script. |\n## _**Return:**_ `*`\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `loadJSON(url: *): *`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| url | `*` | | |\n## _**Return:**_ `*`\n## _**TODO:**_\nwrite docs about it...\n\n---\nsince 2.0.0 `loadScripts(service: Service)`\n\nDeprecated! Use _loadServices_ instead.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| service | `Service` | | |\n## _**Return:**_ `*`\n\n---\nsince 2.2.0 `loadServices(service: Service): *`\n\nLoad _service_ and initialize if function _init_ exists. If _service.url_ is an array of URL's, then load each URL, before calling _init_.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| service | `Service` | | |\n## _**Return:**_ `*`\n\n---\nsince 1.1.2 `next(db: Object, key: string): Object`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| db | `Object` | | |\n| key | `string` | | |\n## _**Return:**_ `Object (nullable: true)` Returns the next data payload of given key.\n\n---\n`off(eventName: string, fn: function)`\n\nDeletes a function with a given name an its function. It can not be triggered afterwards.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| eventName | `string` | | _eventName_ to be deleted. |\n| fn | `function` | optional | Function which will be deleted with respect to _eventName_. |\n## _**TODO:**_ events must also be mutable\n\n---\n`on(eventName: string, fn: function)`\n\nCreates a function on the fly, which can be invoced by the trigger function.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| eventName | `string` | | Functionname to be created |\n| fn | `function` | optional | Function which will be called with respect to the eventName. |\n\n---\nsince 1.1.2 `prev(db: Object, key: string): Object`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| db | `Object` | | |\n| key | `string` | | |\n## _**Return:**_ `Object (nullable: true)` Returns the previous data payload of given key.\n\n---\nsince 2.2.0 `render(site: *)`\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| site | `*` | | |\n## _**TODO:**_ template should be configured in settings\n`render` use _mootools_ selector to get a desired element. These functions must be provided hy the `[services]` middleware stack for a given service.\n\n---\n`trigger(eventName: string, data: Object)`\n\nTriggers eventName as a function and assigns data as parameter.\n## _**Params:**_\n| Name | Type | Attribute | Description |\n|:-|:-|:-|:-|\n| site | `*` | | |\n## _**TODO:**_ description of data is needed.\n\n---\n\n| |\n|-:|\n| Generated by <a href=\"https://esdoc.org/\" target=\"_blank\">ESDoc(1.0.3)</a> |",
"date" : ["2017-04-13T21:14:00+02:00", "2017-10-25T03:27:51+02:00"]
}]
}
22 changes: 12 additions & 10 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@
<link rel="icon" type="image/x-icon" href="./img/favicon.png">
<!-- FAVICON -->

<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-TJTG7J5');</script>
<!-- End Google Tag Manager -->

<!-- SCRIPT -->
<script src="./src/manic.js"></script>
<!-- SCRIPT -->
Expand All @@ -38,20 +46,14 @@
"@type": "Language",
"name": "JavaScript"
},
"dateCreated": "2016-02-07",
"dateModified": "2017-04-14"
"dateCreated": "2013-06-18",
"dateModified": "2017-10-25"
}
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-39025849-3', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-TJTG7J5"
height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<div id="header">
<div class="container">
<div class="three columns">
Expand Down

0 comments on commit 7a2f05f

Please sign in to comment.