Home Explore Help
Sign In
cpp
/
AtomicGameEngine
2
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Browse Source

Custom TypeDoc theme for Atomic

Shaddock Heath 9 years ago
parent
b6730833dc
commit
5742e21277
8 changed files with 161 additions and 3 deletions
Split View Show Diff Stats
  1. 2 2
      Build/Docs/Readme.md
  2. 1 0
      Build/Docs/atomic-theme/assets/css/atomic.css
  3. BIN
      Build/Docs/atomic-theme/assets/images/atomic-icon.png
  4. 52 0
      Build/Docs/atomic-theme/layouts/default.hbs
  5. 73 0
      Build/Docs/atomic-theme/partials/footer.hbs
  6. 24 0
      Build/Docs/atomic-theme/partials/member.sources.hbs
  7. 1 0
      Build/Docs/atomic-theme/theme.js
  8. 8 1
      Build/Docs/gendocs.sh

+ 2 - 2
Build/Docs/Readme.md
View File 

@@ -1,5 +1,5 @@
 
-##Atomic Game Engine™ Javascript Reference
 
+## Atomic Game Engine™ Javascript Reference
 
 
-##EARLY ACCESS DRAFT September 8th 2015
 
+## EARLY ACCESS DRAFT May 2016
 
 
 Atomic Game Engine Core API Reference

+ 1 - 0
Build/Docs/atomic-theme/assets/css/atomic.css
View File 

@@ -0,0 +1 @@
 
+a.title:before { content: ''; display: inline-block; vertical-align: middle; width: 20px; height: 20px; margin: 0 3px 2px 0; background-size: 20px 20px; background-image: url(../images/atomic-icon.png); }

BIN
Build/Docs/atomic-theme/assets/images/atomic-icon.png
View File


+ 52 - 0
Build/Docs/atomic-theme/layouts/default.hbs
View File 

@@ -0,0 +1,52 @@
 
+<!doctype html>
 
+<html class="default no-js">
 
+<head>
 
+    <meta charset="utf-8">
 
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
 
+    <title>{{#ifCond model.name '==' project.name}}{{project.name}}{{else}}{{model.name}} | {{project.name}}{{/ifCond}}</title>
 
+    <meta name="description" content="">
 
+    <meta name="viewport" content="width=device-width, initial-scale=1">
 
+
 
+    <link rel="stylesheet" href="{{relativeURL "assets/css/main.css"}}">
 
+    <link rel="stylesheet" href="{{relativeURL "assets/css/atomic.css"}}">
 
+    <script src="{{relativeURL "assets/js/modernizr.js"}}"></script>
 
+</head>
 
+<body>
 
+
 
+{{> header}}
 
+
 
+<div class="container container-main">
 
+    <div class="row">
 
+        <div class="col-8 col-content">
 
+            {{{contents}}}
 
+        </div>
 
+        <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 
+            <nav class="tsd-navigation primary">
 
+                <ul>
 
+                    {{#each navigation.children}}
 
+                        {{> navigation}}
 
+                    {{/each}}
 
+                </ul>
 
+            </nav>
 
+
 
+            <nav class="tsd-navigation secondary menu-sticky">
 
+                <ul class="before-current">
 
+                    {{#each toc.children}}
 
+                        {{> toc.root}}
 
+                    {{/each}}
 
+                </ul>
 
+            </nav>
 
+        </div>
 
+    </div>
 
+</div>
 
+
 
+{{> footer}}
 
+
 
+<div class="overlay"></div>
 
+<script src="{{relativeURL "assets/js/main.js"}}"></script>
 
+<script>if (location.protocol == 'file:') document.write('<script src="{{relativeURL "assets/js/search.js"}}"><' + '/script>');</script>
 
+
 
+{{> analytics}}
 
+
 
+</body>
 
+</html>

+ 73 - 0
Build/Docs/atomic-theme/partials/footer.hbs
View File 

@@ -0,0 +1,73 @@
 
+
 
+<footer{{#unless settings.hideGenerator}} class="with-border-bottom"{{/unless}}>
 
+    <div class="container">
 
+        <h2>Legend</h2>
 
+        <div class="tsd-legend-group">
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
 
+                <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
 
+                <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
 
+                <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
 
+                <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
 
+                <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
 
+                <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
 
+                <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
 
+                <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
 
+                <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
 
+                <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
 
+                <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
 
+                <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
 
+                <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
 
+                <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
 
+                <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
 
+                <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
 
+                <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
 
+                <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
 
+                <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
 
+                <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
 
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
 
+                <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
 
+                <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
 
+                <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
 
+                <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
 
+                <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
 
+                <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
 
+            </ul>
 
+            <ul class="tsd-legend">
 
+                <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
 
+                <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
 
+            </ul>
 
+        </div>
 
+    </div>
 
+</footer>
 
+
 
+<div class="container">
 
+    <center>
 
+        (c) 2014-2016 THUNDERBEAST GAMES LLC<br>
 
+        (c) 2008-2016 The  <a target="_blank" href="http://urho3d.github.io/">Urho3D</a> Project<br>
 
+    </center>
 
+</div>
 
+
 
+{{#unless settings.hideGenerator}}
 
+    <div class="container tsd-generator">
 
+        <p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
 
+    </div>
 
+{{/unless}}

+ 24 - 0
Build/Docs/atomic-theme/partials/member.sources.hbs
View File 

@@ -0,0 +1,24 @@
 
+<aside class="tsd-sources">
 
+    {{#if implementationOf}}
 
+        <p>Implementation of {{#with implementationOf}}{{> typeAndParent}}{{/with}}</p>
 
+    {{/if}}
 
+    {{#if inheritedFrom}}
 
+        <p>Inherited from {{#with inheritedFrom}}{{> typeAndParent}}{{/with}}</p>
 
+    {{/if}}
 
+    {{#if overwrites}}
 
+        <p>Overwrites {{#with overwrites}}{{> typeAndParent}}{{/with}}</p>
 
+    {{/if}}
 
+    <!--
 
+    {{#if sources}}
 
+        <ul>
 
+            {{#each sources}}
 
+                {{#if url}}
 
+                    <li>Defined in <a href="{{url}}">{{fileName}}:{{line}}</a></li>
 
+                {{else}}
 
+                    <li>Defined in {{fileName}}:{{line}}</li>
 
+                {{/if}}
 
+            {{/each}}
 
+        </ul>
 
+    {{/if}}
 
+    -->
 
+</aside>

+ 1 - 0
Build/Docs/atomic-theme/theme.js
View File 

@@ -0,0 +1 @@
 
+exports = td.output.DefaultTheme;

+ 8 - 1
Build/Docs/gendocs.sh
View File 

@@ -1 +1,8 @@
 
-./node_modules/.bin/jsdoc ../Artifacts/JSDoc/Atomic.js -t ./jaguarjs-jsdoc/ -c ./jsdoc.conf Readme.md
 
+# Shortcut script that generates docs the same way that the CI script does.  Works on OSX.
 
+cp Readme.md ../../Artifacts/Build/JSDoc
 
+cp -R atomic-theme ../../Artifacts/Build/JSDoc/
 
+cd ../../Artifacts/Build/JSDoc
 
+npm install typedoc
 
+./node_modules/.bin/typedoc --out out ../../../Script/TypeScript/dist/Atomic.d.ts --module commonjs --includeDeclarations --mode file --theme atomic-theme --name 'Atomic Game Engine' --readme ./Readme.md
 
+
 
+cp -R out/ ../EditorData/Docs