Skip to content

Commit 482eff8

Browse files
facelegfaceleg
committed
Updated documentation
1 parent b0af474 commit 482eff8

File tree

2 files changed

+326
-11
lines changed

2 files changed

+326
-11
lines changed

‎Reference.html‎

Lines changed: 312 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h2>
6262

6363

6464
<dt>
65-
<h4 class="name" id="Reference"><span class="type-signature"></span>new Reference<span class="signature">(rawRepo, rawReference)</span><span class="type-signature"></span></h4>
65+
<h4 class="name" id="Reference"><span class="type-signature"></span>new Reference<span class="signature">(rawRepo, <span class="optional">rawReference</span>)</span><span class="type-signature"></span></h4>
6666

6767

6868
</dt>
@@ -92,9 +92,13 @@ <h5>Parameters:</h5>
9292
<th>Type</th>
9393

9494

95+
<th>Argument</th>
9596

9697

9798

99+
<th>Default</th>
100+
101+
98102
<th class="last">Description</th>
99103
</tr>
100104
</thead>
@@ -117,9 +121,19 @@ <h5>Parameters:</h5>
117121
</td>
118122

119123

124+
<td class="attributes">
125+
126+
127+
128+
</td>
120129

121130

122131

132+
<td class="default">
133+
134+
</td>
135+
136+
123137
<td class="description last"></td>
124138
</tr>
125139

@@ -134,18 +148,29 @@ <h5>Parameters:</h5>
134148

135149

136150
<span class="param-type">git.raw.Reference</span>
137-
|
138-
139-
<span class="param-type">null</span>
140151

141152

142153

143154
</td>
144155

145156

157+
<td class="attributes">
158+
159+
&lt;optional><br>
160+
161+
162+
163+
</td>
146164

147165

148166

167+
<td class="default">
168+
169+
new git.raw.Reference()
170+
171+
</td>
172+
173+
149174
<td class="description last"></td>
150175
</tr>
151176

@@ -290,7 +315,7 @@ <h5>Parameters:</h5>
290315
<td class="type">
291316

292317

293-
<span class="param-type">Function</span>
318+
<span class="param-type"><a href="Reference.html#lookupCallback">Reference~lookupCallback</a></span>
294319

295320

296321

@@ -403,7 +428,7 @@ <h5>Parameters:</h5>
403428
<td class="type">
404429

405430

406-
<span class="param-type">Function</span>
431+
<span class="param-type"><a href="Reference.html#oidCallback">Reference~oidCallback</a></span>
407432

408433

409434

@@ -444,7 +469,7 @@ <h5>Parameters:</h5>
444469

445470
<dt class="tag-source">Source:</dt>
446471
<dd class="tag-source"><ul class="dummy"><li>
447-
<a href="reference.js.html">reference.js</a>, line 46
472+
<a href="reference.js.html">reference.js</a>, line 51
448473
</li></ul></dd>
449474

450475

@@ -469,6 +494,286 @@ <h5>Parameters:</h5>
469494

470495

471496

497+
<h3 class="subsection-title">Type Definitions</h3>
498+
499+
<dl>
500+
501+
<dt>
502+
<h4 class="name" id="lookupCallback"><span class="type-signature"></span>lookupCallback<span class="signature">(error, reference)</span><span class="type-signature"></span></h4>
503+
504+
505+
</dt>
506+
<dd>
507+
508+
509+
510+
511+
512+
513+
514+
515+
<h5>Parameters:</h5>
516+
517+
518+
<table class="params">
519+
<thead>
520+
<tr>
521+
522+
<th>Name</th>
523+
524+
525+
<th>Type</th>
526+
527+
528+
529+
530+
531+
<th class="last">Description</th>
532+
</tr>
533+
</thead>
534+
535+
<tbody>
536+
537+
538+
<tr>
539+
540+
<td class="name"><code>error</code></td>
541+
542+
543+
<td class="type">
544+
545+
546+
<span class="param-type"><a href="GitError.html">GitError</a></span>
547+
|
548+
549+
<span class="param-type">null</span>
550+
551+
552+
553+
</td>
554+
555+
556+
557+
558+
559+
<td class="description last">An Error or null if successful.</td>
560+
</tr>
561+
562+
563+
564+
<tr>
565+
566+
<td class="name"><code>reference</code></td>
567+
568+
569+
<td class="type">
570+
571+
572+
<span class="param-type"><a href="Reference.html">Reference</a></span>
573+
|
574+
575+
<span class="param-type">null</span>
576+
577+
578+
579+
</td>
580+
581+
582+
583+
584+
585+
<td class="description last">Retrieved reference object or null.</td>
586+
</tr>
587+
588+
589+
</tbody>
590+
</table>
591+
592+
593+
594+
<dl class="details">
595+
596+
597+
598+
599+
600+
601+
602+
603+
604+
605+
606+
607+
608+
609+
610+
611+
612+
613+
614+
<dt class="tag-source">Source:</dt>
615+
<dd class="tag-source"><ul class="dummy"><li>
616+
<a href="reference.js.html">reference.js</a>, line 31
617+
</li></ul></dd>
618+
619+
620+
621+
622+
623+
624+
625+
</dl>
626+
627+
628+
629+
630+
631+
632+
633+
634+
635+
</dd>
636+
637+
638+
639+
<dt>
640+
<h4 class="name" id="oidCallback"><span class="type-signature"></span>oidCallback<span class="signature">(error, oid)</span><span class="type-signature"></span></h4>
641+
642+
643+
</dt>
644+
<dd>
645+
646+
647+
648+
649+
650+
651+
652+
653+
<h5>Parameters:</h5>
654+
655+
656+
<table class="params">
657+
<thead>
658+
<tr>
659+
660+
<th>Name</th>
661+
662+
663+
<th>Type</th>
664+
665+
666+
667+
668+
669+
<th class="last">Description</th>
670+
</tr>
671+
</thead>
672+
673+
<tbody>
674+
675+
676+
<tr>
677+
678+
<td class="name"><code>error</code></td>
679+
680+
681+
<td class="type">
682+
683+
684+
<span class="param-type"><a href="GitError.html">GitError</a></span>
685+
|
686+
687+
<span class="param-type">null</span>
688+
689+
690+
691+
</td>
692+
693+
694+
695+
696+
697+
<td class="description last">An Error or null if successful.</td>
698+
</tr>
699+
700+
701+
702+
<tr>
703+
704+
<td class="name"><code>oid</code></td>
705+
706+
707+
<td class="type">
708+
709+
710+
<span class="param-type"><a href="Oid.html">Oid</a></span>
711+
|
712+
713+
<span class="param-type">null</span>
714+
715+
716+
717+
</td>
718+
719+
720+
721+
722+
723+
<td class="description last">Retrieved Oid object or null.</td>
724+
</tr>
725+
726+
727+
</tbody>
728+
</table>
729+
730+
731+
732+
<dl class="details">
733+
734+
735+
736+
737+
738+
739+
740+
741+
742+
743+
744+
745+
746+
747+
748+
749+
750+
751+
752+
<dt class="tag-source">Source:</dt>
753+
<dd class="tag-source"><ul class="dummy"><li>
754+
<a href="reference.js.html">reference.js</a>, line 52
755+
</li></ul></dd>
756+
757+
758+
759+
760+
761+
762+
763+
</dl>
764+
765+
766+
767+
768+
769+
770+
771+
772+
773+
</dd>
774+
775+
</dl>
776+
472777

473778

474779
</article>

0 commit comments

Comments
 (0)