Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge docs #189 #257

Merged
merged 69 commits into from
Jun 22, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
69 commits
Select commit Hold shift click to select a range
8138f59
Moves types from DT fork - Adds typescript and tslint to deps #189
hirako2000 Jun 2, 2017
8487faf
Adds jsdoc #189
hirako2000 Jun 8, 2017
359d8b9
Adds some js doc for CameraComponent, just for testing #189
hirako2000 Jun 13, 2017
434d17d
Renames gulp task to build doc #189
hirako2000 Jun 13, 2017
d1d8b36
Adds minami jsdoc theme, cleans up gulp doc build task #189
hirako2000 Jun 13, 2017
cc01cec
Rename task to docs
sasha240100 Jun 17, 2017
80dee6f
New design
sasha240100 Jun 17, 2017
29d8aea
Fix heading
sasha240100 Jun 17, 2017
582d49d
Fix path again
sasha240100 Jun 17, 2017
fec9521
wip: first steps with documenting
sasha240100 Jun 18, 2017
0a6ad5a
wip: document CameraComponent and Component
sasha240100 Jun 18, 2017
02f8e67
Add a sidebar
sasha240100 Jun 19, 2017
2cbed8d
RM docs/public/
sasha240100 Jun 19, 2017
1bfaf44
Fixes jsdoc template to render on ordinary desktop browser and smalle…
hirako2000 Jun 19, 2017
20518a0
Removes extra width from welcome content - #189
hirako2000 Jun 20, 2017
782d577
Removes float to make welcome content fit on mobile screen - adjusts …
hirako2000 Jun 20, 2017
1232f7c
Adds background to pre > code (used in example snippets) - #189
hirako2000 Jun 20, 2017
107f678
Adds FogModule doc - #189
hirako2000 Jun 20, 2017
f31e2ea
Adjusts module structure a bit, add basic doc for a few more classes …
hirako2000 Jun 20, 2017
4084afe
Fixes Component doc as its module changed - adds some basic doc for R…
hirako2000 Jun 20, 2017
0c2fd80
Adds doc for RenderingModule #189
hirako2000 Jun 20, 2017
3b4359a
Improves texture module doc, example as from our readme
hirako2000 Jun 20, 2017
7125624
Adds doc for Element module - #189
hirako2000 Jun 20, 2017
a6d56ef
Adds doc for App component - #189
hirako2000 Jun 20, 2017
47f3cd7
Fix style argv
sasha240100 Jun 20, 2017
83478fc
Merge remote-tracking branch 'origin/#189' into #189
sasha240100 Jun 20, 2017
27e230b
Adds doc for ModuleSystem - #189
hirako2000 Jun 20, 2017
0fb9a8c
Merge branch '#189' of https://github.com/WhitestormJS/whitestorm.js …
hirako2000 Jun 20, 2017
3418a09
fixes module system example in #189
hirako2000 Jun 20, 2017
ffd3dea
Sets back to build Component.js only #189
hirako2000 Jun 20, 2017
851e903
Add category
sasha240100 Jun 20, 2017
10e3693
Adds doc for Loop - #189
hirako2000 Jun 20, 2017
1fe1004
Adds doc for AmbientLight - #189
hirako2000 Jun 20, 2017
e399ebd
Adds doc for DirectionalLight - #189
hirako2000 Jun 20, 2017
b9b562d
Adds doc for HemisphereLight - #189
hirako2000 Jun 20, 2017
6693f70
Add minor ui changes
sasha240100 Jun 20, 2017
2e8cff7
Adds doc for PointLight - #189
hirako2000 Jun 20, 2017
c0dee70
Fix example page
sasha240100 Jun 20, 2017
187965e
Remove console.log
sasha240100 Jun 20, 2017
5f8d408
Adds @category where it’s missing - #189
hirako2000 Jun 20, 2017
e14693a
Fix less
sasha240100 Jun 20, 2017
53eeae9
Fix --all
sasha240100 Jun 20, 2017
639f2de
Add code to default
sasha240100 Jun 20, 2017
8b665b2
Adds doc for SpotLight - #189
hirako2000 Jun 20, 2017
1a44e5b
Fix index.html bug & styles
sasha240100 Jun 21, 2017
762dd99
Adds doc for ModuleManager - #189
hirako2000 Jun 21, 2017
1c71ced
Data file
sasha240100 Jun 21, 2017
f780e42
Adds doc for Box - #189
hirako2000 Jun 21, 2017
5f94402
Adds doc for Cylinder - #189
hirako2000 Jun 21, 2017
21a86d0
Add tutorial pages
sasha240100 Jun 21, 2017
4e46863
Merge remote-tracking branch 'origin/#189' into #189
sasha240100 Jun 21, 2017
cd62941
Adds doc for Dodecahedron - #189
hirako2000 Jun 21, 2017
1ba9a98
Add tutorials
sasha240100 Jun 21, 2017
b570f83
Adds doc for Extrude - #189
hirako2000 Jun 21, 2017
68e3354
Adds doc for Group - #189
hirako2000 Jun 21, 2017
3c4df27
Adds doc for Icosahedron - #189
hirako2000 Jun 21, 2017
9c7e927
Adds doc for all cameras - #189
hirako2000 Jun 21, 2017
d50ace2
Add commands & styles
sasha240100 Jun 21, 2017
7689341
Adds doc Lathe - #189
hirako2000 Jun 21, 2017
f252a59
Adds doc Line - #189
hirako2000 Jun 21, 2017
25e25f6
Adds doc for Octahedron, Parametric and Plane - #189
hirako2000 Jun 21, 2017
e7e54c5
Add links
sasha240100 Jun 22, 2017
6e094d7
Adds doc for Polyhedron - removes old physics/softbody fields - #189
hirako2000 Jun 22, 2017
3433418
Adds doc for Ring - fixes its instructions and remove old softbody ch…
hirako2000 Jun 22, 2017
e6fddb2
Adds doc for Plane - removes old softbody check - #189
hirako2000 Jun 22, 2017
4c1e469
Remove extras & compact
sasha240100 Jun 22, 2017
4cb5e83
Merge remote-tracking branch 'origin/#189' into #189
sasha240100 Jun 22, 2017
0119899
Fix docs ancestors
sasha240100 Jun 22, 2017
f8979b5
Merge branch 'beta' into #189
sasha240100 Jun 22, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add minor ui changes
  • Loading branch information
sasha240100 committed Jun 20, 2017
commit 6693f70903a2fcfe8281d731fd03f73faf55cdca
20 changes: 13 additions & 7 deletions docs/template/publish.js
Original file line number Diff line number Diff line change
Expand Up @@ -402,15 402,19 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
if (items && items.length) {
var itemsNav = ""
var categories = {none: []};
var categoryLinks = {};

nav.push(buildNavHeading(itemHeading))
nav.push(buildNavHeading(itemHeading, false, true))

items.forEach(function(item) {
if (itemHeading === "Classes" && item.category) {
var name = item.category.name;

if (!categories[name]) categories[name] = [item];
else categories[name].push(item);
if (!categories[name]) {
categories[name] = [item];
categoryLinks[name] = linktoFn(item.memberof, name);
console.log(item);
} else categories[name].push(item);
} else {
categories.none.push(item);
}
Expand Down Expand Up @@ -446,6 450,7 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
if (itemHeading === 'Tutorials') {
nav.push(buildNavItem(linktoFn(item.longname, displayName)))
} else {
console.log(item.longname);
nav.push(buildNavHeading(buildNavType(item.kind, linktoFn(item.longname, displayName))))
}

Expand All @@ -467,8 472,9 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {

for (let key in categories) {
if (key !== 'none') {
nav.push(buildNavHeading(key));
categories[key].forEach(processItemEach)
console.log(categoryLinks[key]);
nav.push(buildNavHeading(categoryLinks[key], true));
categories[key].forEach(processItemEach);
}
}
}
Expand Down Expand Up @@ -507,9 513,9 @@ function buildNavLink (linkClass, linkContent) {
* @param {String} content navigation header content
* @return {String}
*/
function buildNavHeading (content) {
function buildNavHeading (content, pad, margin) {
return [
'<li class="nav-heading">',
'<li class="nav-heading ' (pad ? 'pad ' : '') (margin ? 'margin' : '') '">',
content,
'</li>'
].join('')
Expand Down
11 changes: 11 additions & 0 deletions docs/template/static/less/jsdoc-default.less
Original file line number Diff line number Diff line change
Expand Up @@ -1095,3 1095,14 @@ dl.param-type {
position: relative;
width: 50%;
}

.pad {
a {
color: #4d4e53;
line-height: 1.5;
}
}

.margin {
margin-top: 30px;
}
6 changes: 4 additions & 2 deletions gulp/docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 4,7 @@ import watch from 'gulp-watch';
import config from '../jsdoc';
import less from 'gulp-less';
import del from 'del';
import {argv} from 'yargs';

gulp.task('docs', cb => {
del('./docs/public/*.html');
Expand All @@ -12,7 13,7 @@ gulp.task('docs', cb => {
.pipe(less())
.pipe(gulp.dest('./docs/public/styles/'));

gulp.src(['./docs/data/**/*', './src/core/Component.js']) // ['README.md', './src/**/*.js']
gulp.src(['./docs/data/**/*', argv.all ? './src/**/*.js' : './src/core/Component.js'])
.pipe(jsdoc(config, cb));
});

Expand All @@ -31,13 32,14 @@ gulp.task('docs:watch', ['docs'], () => {

return watch([
'./docs/template/**/*.tmpl',
'./docs/template/publish.js',
'./docs/data/**/*',
'./src/core/*.js'
], () => {
del('./docs/public/*.html');
console.log(`update #${i }`);

gulp.src(['./docs/data/**/*.md', './src/core/Component.js', './src/core/CameraComponent.js'])
gulp.src(['./docs/data/**/*.md', argv.all ? './src/**/*.js' : './src/core/Component.js'])
.pipe(jsdoc(config));
});
});
2 changes: 1 addition & 1 deletion src/core/App.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 3,7 @@ import {ModuleSystem} from './ModuleSystem';
import {ModuleManager} from './ModuleManager';
/**
* @class App
* @category Core
* @category core
* @description This component is used to prepare a world scene, setup physics, camera, renderer and all other things that you usually do before making meshes.
* @param {Array} [modules=[]] - Array of Modules
* @extends ModuleSystem
Expand Down
2 changes: 1 addition & 1 deletion src/core/CameraComponent.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 8,7 @@ import {CompositionError} from './errors';
)
/**
* @class CameraComponent
* @category Core
* @category core
* @param {Object} [params] - The parameters object.
* @param {Object} [instructions] - The instructions object.
* @extends Component
Expand Down
2 changes: 1 addition & 1 deletion src/core/Component.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 5,7 @@ import {ManagerError} from './errors';

/**
* @class Component
* @category Core
* @category core
* @param {Object} [params] - The parameters object.
* @param {Object} [instructions] - The instructions object.
* @extends ModuleSystem
Expand Down
2 changes: 1 addition & 1 deletion src/modules/app/ElementModule.js
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
/**
* @class ElementModule
* @category Modules/App
* @category modules/app
* @param {Object} [params={container: document.body}] container is the DOM object to which application's canvas will be added to.
* @memberof module:modules/app
* @example <caption>Creating an element module, passing it to the App</caption>
Expand Down
2 changes: 1 addition & 1 deletion src/modules/app/FogModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 5,7 @@ import {

/**
* @class FogModule
* @category Modules/App
* @category modules/app
* @param {Object} [params={color: 0xefd1b5, density: 0.020, near: 10, far: 1000}] - The parameters object.
* @param {String} [type=exp2] - The type of fog - exp2 or linear
* @memberof module:modules/app
Expand Down
1 change: 1 addition & 0 deletions src/modules/app/RenderingModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 7,7 @@ import {Loop} from '../../core/Loop';

/**
* @class RenderingModule
* @category modules/app
* @param {Object} [params]
* @memberof module:modules/app
* @example <caption> Creating a rendering module and passing it to App's modules</caption>
Expand Down
2 changes: 1 addition & 1 deletion src/modules/app/ResizeModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 2,7 @@

/**
* @class ResizeModule
* @category Modules/App
* @category modules/app
* @param {Object} [params={auto: true}] - If auto is set to true - resize will be triggered when container resizes
* @memberof module:modules/app
*/
Expand Down
2 changes: 1 addition & 1 deletion src/modules/app/SceneModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 4,7 @@ import {

/**
* @class SceneModule
* @category Modules/App
* @category modules/app
* @param {Boolean} [willSceneBeReplaced=false] willSceneBeReplaced should be true only if you are going to overwrite scene dependency even without the use of default one.
* @memberof module:modules/app
*/
Expand Down
2 changes: 1 addition & 1 deletion src/modules/app/VirtualMouseModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 10,7 @@ import {EventsPatchModule} from './EventsPatchModule';

/**
* @class VirtualMouseModule
* @category Modules/App
* @category modules/app
* @param {Boolean} [globalMovement=false]
* @param {Boolean} [patchEvents=true]
* @memberof module:modules/app
Expand Down
2 changes: 1 addition & 1 deletion src/modules/mesh/DynamicGeometryModule.js
Original file line number Diff line number Diff line change
@@ -1,6 1,6 @@
/**
* @class DynamicGeometryModule
* @category Modules/Mesh
* @category modules/mesh
* @param {Object} [params={attributes: false}] - params
* @param {Boolean} [patchEvents=true]
* @memberof module:modules/mesh
Expand Down
2 changes: 1 addition & 1 deletion src/modules/mesh/TextureModule.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 11,7 @@ const loader = new TextureLoader();

/**
* @class TextureModule
* @category Modules/Mesh
* @category modules/mesh
* @description A TextureModule can be applied to any Mesh or Model.
* @param {Array} [textures] - array of texture objects
* @memberof module:modules/mesh
Expand Down