api-builder: move templates into angular.io package

2015-11-13 14:08:25 +00:00
parent a98085e7eb
commit 888f9ff8d8
16 changed files with 2 additions and 95 deletions
@@ -0,0 +1 @@
+{% extends 'var.template.html' -%}
@@ -0,0 +1 @@
+{% extends 'class.template.html' -%}
@@ -0,0 +1,7 @@
+{% macro githubHref(doc) -%}
+https://github.com/{$ versionInfo.gitRepoInfo.owner $}/{$ versionInfo.gitRepoInfo.repo $}/tree/{$ versionInfo.currentVersion.isSnapshot and versionInfo.currentVersion.SHA or versionInfo.currentVersion.raw $}/modules/{$ doc.fileInfo.relativePath $}#L{$ doc.location.start.line+1 $}-L{$ doc.location.end.line+1 $}
+{%- endmacro %}
+
+{% macro githubViewLink(doc) -%}
+  <a href="{$ githubHref(doc) $}">{$ doc.fileInfo.relativePath $} (line {$ doc.location.start.line+1 $})</a>
+{%- endmacro -%}
@@ -0,0 +1,74 @@
+{% include "lib/githubLinks.html" -%}
+{% include "lib/paramList.html" -%}
+<!DOCTYPE html>
+<html>
+<head>
+  <title></title>
+  <style>
+    body {
+      max-width: 1000px;
+    }
+    h2 {
+      margin-top: 20px;
+      margin-bottom: 0;
+      border-bottom: solid 1px black;
+    }
+    h3 {
+      margin-top: 10px;
+      margin-bottom: 0;
+      padding-left: 20px;
+    }
+    h4 {
+      padding-left: 30px;
+      margin: 0;
+    }
+    .not-documented::after {
+      content: "(not documented)";
+      font-size: small;
+      font-style: italic;
+      color: red;
+    }
+    a {
+      color: black;
+      text-decoration: none;
+    }
+  </style>
+</head>
+<body>
+
+
+<h1>Module Overview</h1>
+
+{% for module in doc.modules %}
+
+<h2>
+  <code>{$ module.id $}{%- if module.public %} (public){% endif %}</code>
+</h2>
+
+  {% for export in module.exports %}
+  <h3 {% if export.notYetDocumented %}class="not-documented"{% endif %}>
+    <a href="{$ githubHref(export) $}">
+    <code>{$ export.docType $} {$ export.name $}</code>
+    </a>
+  </h3>
+      {%- if export.constructorDoc %}
+      <h4  {% if export.constructorDoc.notYetDocumented %}class="not-documented"{% endif %}>
+        <a href="{$ githubHref(export.constructorDoc) $}">
+        <code>{$ export.constructorDoc.name $}{$ paramList(export.constructorDoc.params) $}</code>
+        </a>
+      </h4>
+    {% endif -%}
+    {%- for member in export.members %}
+      <h4 {% if member.notYetDocumented %}class="not-documented"{% endif %}>
+        <a href="{$ githubHref(member) $}">
+        <code>{$ member.name $}{$ paramList(member.params) $}</code>
+        </a>
+      </h4>
+    {% endfor %}
+
+  {% endfor %}
+
+{% endfor %}
+
+</body>
+</html>
@@ -0,0 +1,10 @@
+{% include "lib/githubLinks.html" -%}
+{% extends 'layout/base.template.html' %}
+
+{% block body %}
+<h1>{$ doc.name $} <span class="type">type alias</span></h1>
+<p class="module">exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }<br/>
+defined in {$ githubViewLink(doc) $}</p>
+<p>{$ doc.description | marked $}</p>
+
+{% endblock %}