File tree Expand file tree Collapse file tree 3 files changed +92
-1
lines changed
Expand file tree Collapse file tree 3 files changed +92
-1
lines changed Original file line number Diff line number Diff line change 9090 <% if (property.properties) { %>
9191 <ul>
9292 <% property.properties.forEach(function(property) { %>
93- <li><code><%- name%></code> <%= formatType(property.type) %>
93+ <li><code><%- property. name %></code> <%= formatType(property.type) %>
9494 <% if (property.default) { %>
9595 (default <code><%- property.default %></code>)
9696 <% } %>
Original file line number Diff line number Diff line change @@ -29,6 +29,15 @@ Klass.prototype.getFoo = function () {
2929Klass . prototype . withOptions = function ( options , otherOptions ) {
3030} ;
3131
32+ /**
33+ * @typedef CustomError
34+ * @name CustomError
35+ * @description a typedef with nested properties
36+ * @property {object } error An error
37+ * @property {string } error.code The error's code
38+ * @property {string } error.description The error's description
39+ */
40+
3241/**
3342 * Decide whether an object is a Klass instance
3443 * This is a [klasssic]{@link Klass}
Original file line number Diff line number Diff line change 9898 </li>
9999
100100
101+ <li><a
102+ href='#customerror'
103+ class="">
104+ CustomError
105+
106+ </a>
107+
108+ </li>
109+
110+
101111 <li><a
102112 href='#bar'
103113 class="">
@@ -793,6 +803,78 @@ k.isArrayOfBuffers();</pre>
793803
794804
795805
806+ </section>
807+
808+
809+
810+
811+ <section class='p2 mb2 clearfix bg-white minishadow'>
812+
813+
814+ <div class='clearfix'>
815+
816+ <h3 class='fl m0' id='customerror'>
817+ CustomError
818+ </h3>
819+
820+
821+ </div>
822+
823+
824+ <p>a typedef with nested properties</p>
825+
826+
827+ <div class='pre p1 fill-light mt0'>CustomError</div>
828+
829+
830+
831+
832+
833+
834+
835+
836+
837+
838+
839+
840+ <div class='py1 quiet mt1 prose-big'>Properties</div>
841+ <div>
842+
843+ <div class='space-bottom0'>
844+ <span class='code bold'>error</span> <code class='quiet'>(<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
845+ : An error
846+
847+
848+ <ul>
849+
850+ <li><code>error.code</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>
851+
852+ <p>The error's code</p>
853+ </li>
854+
855+ <li><code>error.description</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>
856+
857+ <p>The error's description</p>
858+ </li>
859+
860+ </ul>
861+
862+ </div>
863+
864+ </div>
865+
866+
867+
868+
869+
870+
871+
872+
873+
874+
875+
876+
877+
796878</section>
797879
798880
You can’t perform that action at this time.
0 commit comments