Skip to content

Commit f5761a4

Browse files
showing description before examples in reference section
1 parent 0a9ce34 commit f5761a4

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

src/assets/js/reference.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2445,7 +2445,11 @@ define('listView',[
24452445
});
24462446

24472447

2448+
<<<<<<< Updated upstream
24482449
define('text!tpl/item.html',[],function () { return '<h2><%=item.name%><% if (item.isMethod) { %>()<% } %></h2>\n\n<% if (item.example) { %>\n<div class="example">\n <h3 id="reference-example">Examples</h3>\n\n <div class="example-content" data-alt="<%= item.alt %>">\n <% _.each(item.example, function(example, i){ %>\n <%= example %>\n <% }); %>\n </div>\n</div>\n<% } %>\n\n<div class="description">\n\n <h3 id="reference-description">Description</h3>\n\n <% if (item.deprecated) { %>\n <p>\n Deprecated: <%=item.name%><% if (item.isMethod) { %>()<% } %> is deprecated and will be removed in a future version of p5. <% if (item.deprecationMessage) { %><%=item.deprecationMessage%><% } %>\n </p>\n <% } %>\n\n\n <span class=\'description-text\'><%= item.description %></span>\n\n <% if (item.extends) { %>\n <p><span id="reference-extends">Extends</span> <a href="/reference/#/<%=item.extends%>" title="<%=item.extends%> reference"><%=item.extends%></a></p>\n <% } %>\n\n <% if (item.module === \'p5.sound\') { %>\n <p>This function requires you include the p5.sound library. Add the following into the head of your index.html file:\n <pre><code class="language-javascript">&lt;script src="path/to/p5.sound.js"&gt;&lt;/script&gt;</code></pre>\n </p>\n <% } %>\n\n <% if (item.constRefs) { %>\n <p>Used by:\n <%\n var refs = item.constRefs;\n for (var i = 0; i < refs.length; i ++) {\n var ref = refs[i];\n var name = ref;\n if (name.substr(0, 3) === \'p5.\') {\n name = name.substr(3);\n }\n if (i !== 0) {\n if (i == refs.length - 1) {\n %> and <%\n } else {\n %>, <%\n }\n }\n %><a href="./#/<%= ref.replace(\'.\', \'/\') %>"><%= name %>()</a><%\n }\n %>\n </p>\n <% } %>\n</div>\n\n<% if (isConstructor || !isClass) { %>\n\n<div class="syntax">\n <h3 id="reference-syntax">Syntax</h3>\n <p>\n <% syntaxes.forEach(function(syntax) { %>\n <pre class="language-javascript"><%= syntax %></pre>\n <% }) %>\n </p>\n</div>\n\n\n<% if (item.params) { %>\n <div class="params">\n <h3 id="reference-parameters">Parameters</h3>\n <ul aria-labelledby=\'reference-parameters\'>\n <% for (var i=0; i<item.params.length; i++) { %>\n <% var p = item.params[i] %>\n <li>\n <div class=\'paramname\'><%=p.name%></div>\n <% if (p.type) { %>\n <div class=\'paramtype\'>\n <% var type = p.type.replace(/(p5\\.[A-Z][A-Za-z]*)/, \'<a href="#/$1">$1</a>\'); %>\n <span class="param-type label label-info"><%=type%></span>: <%=p.description%>\n <% if (p.optional) { %> (Optional)<% } %>\n </div>\n <% } %>\n </li>\n <% } %>\n </ul>\n </div>\n<% } %>\n\n<% if (item.return && item.return.type) { %>\n <div>\n <h3 id="reference-returns">Returns</h3>\n <p class=\'returns\'><span class="param-type label label-info"><%=item.return.type%></span>: <%= item.return.description %></p>\n </div>\n<% } %>\n\n<% } %>\n';});
2450+
=======
2451+
define('text!tpl/item.html',[],function () { return '<h2><%=item.name%><% if (item.isMethod) { %>()<% } %></h2>\r\n\r\n\r\n\r\n<div class="description">\r\n\r\n <h3 id="reference-description">Description</h3>\r\n\r\n <% if (item.deprecated) { %>\r\n <p>\r\n Deprecated: <%=item.name%><% if (item.isMethod) { %>()<% } %> is deprecated and will be removed in a future version of p5. <% if (item.deprecationMessage) { %><%=item.deprecationMessage%><% } %>\r\n </p>\r\n <% } %>\r\n\r\n\r\n <span class=\'description-text\'><%= item.description %></span>\r\n\r\n <% if (item.extends) { %>\r\n <p><span id="reference-extends">Extends</span> <a href="/reference/#/<%=item.extends%>" title="<%=item.extends%> reference"><%=item.extends%></a></p>\r\n <% } %>\r\n\r\n <% if (item.module === \'p5.sound\') { %>\r\n <p>This function requires you include the p5.sound library. Add the following into the head of your index.html file:\r\n <pre><code class="language-javascript">&lt;script src="path/to/p5.sound.js"&gt;&lt;/script&gt;</code></pre>\r\n </p>\r\n <% } %>\r\n\r\n <% if (item.constRefs) { %>\r\n <p>Used by:\r\n <%\r\n var refs = item.constRefs;\r\n for (var i = 0; i < refs.length; i ++) {\r\n var ref = refs[i];\r\n var name = ref;\r\n if (name.substr(0, 3) === \'p5.\') {\r\n name = name.substr(3);\r\n }\r\n if (i !== 0) {\r\n if (i == refs.length - 1) {\r\n %> and <%\r\n } else {\r\n %>, <%\r\n }\r\n }\r\n %><a href="./#/<%= ref.replace(\'.\', \'/\') %>"><%= name %>()</a><%\r\n }\r\n %>\r\n </p>\r\n <% } %>\r\n</div>\r\n\r\n\r\n\r\n<% if (item.example) { %>\r\n <div class="example">\r\n <h3 id="reference-example">Examples</h3>\r\n \r\n <div class="example-content" data-alt="<%= item.alt %>">\r\n <% _.each(item.example, function(example, i){ %>\r\n <%= example %>\r\n <% }); %>\r\n </div>\r\n </div>\r\n <% } %>\r\n\r\n<% if (isConstructor || !isClass) { %>\r\n\r\n<div class="syntax">\r\n <h3 id="reference-syntax">Syntax</h3>\r\n <p>\r\n <% syntaxes.forEach(function(syntax) { %>\r\n <pre class="language-javascript"><%= syntax %></pre>\r\n <% }) %>\r\n </p>\r\n</div>\r\n\r\n\r\n<% if (item.params) { %>\r\n <div class="params">\r\n <h3 id="reference-parameters">Parameters</h3>\r\n <ul aria-labelledby=\'reference-parameters\'>\r\n <% for (var i=0; i<item.params.length; i++) { %>\r\n <% var p = item.params[i] %>\r\n <li>\r\n <div class=\'paramname\'><%=p.name%></div>\r\n <% if (p.type) { %>\r\n <div class=\'paramtype\'>\r\n <% var type = p.type.replace(/(p5\\.[A-Z][A-Za-z]*)/, \'<a href="#/$1">$1</a>\'); %>\r\n <span class="param-type label label-info"><%=type%></span>: <%=p.description%>\r\n <% if (p.optional) { %> (Optional)<% } %>\r\n </div>\r\n <% } %>\r\n </li>\r\n <% } %>\r\n </ul>\r\n </div>\r\n<% } %>\r\n\r\n<% if (item.return && item.return.type) { %>\r\n <div>\r\n <h3 id="reference-returns">Returns</h3>\r\n <p class=\'returns\'><span class="param-type label label-info"><%=item.return.type%></span>: <%= item.return.description %></p>\r\n </div>\r\n<% } %>\r\n\r\n<% } %>\r\n\r\n';});
2452+
>>>>>>> Stashed changes
24492453

24502454

24512455
define('text!tpl/class.html',[],function () { return '\n<% if (typeof constructor !== \'undefined\') { %>\n<div class="constructor">\n <%=constructor%>\n</div>\n<% } %>\n\n<% let fields = _.filter(things, function(item) { return item.itemtype === \'property\' && item.access !== \'private\' }); %>\n<% if (fields.length > 0) { %>\n <h3 id=\'reference-fields\'>Fields</h3>\n <ul aria-labelledby=\'reference-fields\'>\n <% _.each(fields, function(item) { %>\n <li>\n <div class=\'paramname\'><a href="<%=item.hash%>" <% if (item.module !== module) { %>class="addon"<% } %>><%=item.name%></a></div>\n <div class=\'paramtype\'><%= item.description %></div>\n </li>\n <% }); %>\n </ul>\n<% } %>\n\n<% let methods = _.filter(things, function(item) { return item.itemtype === \'method\' && item.access !== \'private\' }); %>\n<% if (methods.length > 0) { %>\n <h3 id=\'reference-methods\'>Methods</h3>\n <ul aria-labelledby=\'reference-methods\'>\n <% _.each(methods, function(item) { %>\n <li>\n <div class=\'paramname\'><a href="<%=item.hash%>" <% if (item.module !== module) { %>class="addon"<% } %>><%=item.name%><% if (item.itemtype === \'method\') { %>()<%}%></a></div>\n <div class=\'paramtype\'><%= item.description %></div>\n </li>\n <% }); %>\n </ul>\n<% } %>\n';});

src/yuidoc-p5-theme-src/scripts/tpl/item.html

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
11
<h2><%=item.name%><% if (item.isMethod) { %>()<% } %></h2>
22

3-
<% if (item.example) { %>
4-
<div class="example">
5-
<h3 id="reference-example">Examples</h3>
63

7-
<div class="example-content" data-alt="<%= item.alt %>">
8-
<% _.each(item.example, function(example, i){ %>
9-
<%= example %>
10-
<% }); %>
11-
</div>
12-
</div>
13-
<% } %>
144

155
<div class="description">
166

@@ -59,6 +49,20 @@ <h3 id="reference-description">Description</h3>
5949
<% } %>
6050
</div>
6151

52+
53+
54+
<% if (item.example) { %>
55+
<div class="example">
56+
<h3 id="reference-example">Examples</h3>
57+
58+
<div class="example-content" data-alt="<%= item.alt %>">
59+
<% _.each(item.example, function(example, i){ %>
60+
<%= example %>
61+
<% }); %>
62+
</div>
63+
</div>
64+
<% } %>
65+
6266
<% if (isConstructor || !isClass) { %>
6367

6468
<div class="syntax">
@@ -100,3 +104,4 @@ <h3 id="reference-returns">Returns</h3>
100104
<% } %>
101105

102106
<% } %>
107+

0 commit comments

Comments
 (0)