diff options
| author | Marak <[email protected]> | 2020-08-22 21:08:31 -0400 |
|---|---|---|
| committer | Marak <[email protected]> | 2020-08-22 21:08:31 -0400 |
| commit | 868ab94a8d8700fa46155283784ab5538181cef1 (patch) | |
| tree | ac885e1d753df9205c3dbbf1145ad3ac4b35074a /doc/faker.git.html | |
| parent | efa4c64e60858c05c69adcb37645e8a58577809a (diff) | |
| download | faker-868ab94a8d8700fa46155283784ab5538181cef1.tar.xz faker-868ab94a8d8700fa46155283784ab5538181cef1.zip | |
Update generated docs and ReadMe
Update Licenses
Diffstat (limited to 'doc/faker.git.html')
| -rw-r--r-- | doc/faker.git.html | 2147 |
1 files changed, 2147 insertions, 0 deletions
diff --git a/doc/faker.git.html b/doc/faker.git.html new file mode 100644 index 00000000..9b804bac --- /dev/null +++ b/doc/faker.git.html @@ -0,0 +1,2147 @@ +<!DOCTYPE html> + +<html lang="en"> +<head> + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width"> + <title>Documentation Namespace: git</title> + + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> + + <link type="text/css" rel="stylesheet" href="styles/site.simplex.css"> + +</head> + +<body> + +<div class="navbar navbar-default navbar-fixed-top "> +<div class="container"> + <div class="navbar-header"> + <a class="navbar-brand" href="index.html">Documentation</a> + <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + </div> + <div class="navbar-collapse collapse" id="topNavigation"> + <ul class="nav navbar-nav"> + + <li class="dropdown"> + <a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b class="caret"></b></a> + <ul class="dropdown-menu "> + <li><a href="faker.html">faker</a></li><li><a href="faker.address.html">faker.address</a></li><li><a href="faker.commerce.html">faker.commerce</a></li><li><a href="faker.company.html">faker.company</a></li><li><a href="faker.database.html">faker.database</a></li><li><a href="faker.date.html">faker.date</a></li><li><a href="faker.finance.html">faker.finance</a></li><li><a href="faker.git.html">faker.git</a></li><li><a href="faker.hacker.html">faker.hacker</a></li><li><a href="faker.helpers.html">faker.helpers</a></li><li><a href="faker.image.html">faker.image</a></li><li><a href="faker.image.lorempixel.html">faker.image.lorempixel</a></li><li><a href="faker.image.unsplash.html">faker.image.unsplash</a></li><li><a href="faker.internet.html">faker.internet</a></li><li><a href="faker.lorem.html">faker.lorem</a></li><li><a href="faker.name.html">faker.name</a></li><li><a href="faker.phone.html">faker.phone</a></li><li><a href="faker.random.html">faker.random</a></li><li><a href="faker.system.html">faker.system</a></li><li><a href="faker.time.html">faker.time</a></li><li><a href="faker.unique.html">faker.unique</a></li><li><a href="faker.vehicle.html">faker.vehicle</a></li> + </ul> + </li> + + <li class="dropdown"> + <a href="global.html" class="dropdown-toggle" data-toggle="dropdown">Global<b class="caret"></b></a> + <ul class="dropdown-menu "> + <li><a href="global.html#unique">unique</a></li> + </ul> + </li> + + </ul> + + <div class="col-sm-3 col-md-3"> + <form class="navbar-form" role="search"> + <div class="input-group"> + <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> + <div class="input-group-btn"> + <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> + </div> + </div> + </form> + </div> + + </div> + +</div> +</div> + + +<div class="container" id="toc-content"> +<div class="row"> + + + <div class="col-md-8"> + + <div id="main"> + + + <h1 class="page-title">Namespace: git</h1> +<section> + +<header> + + <h2> + <span class="ancestors"><a href="faker.html">faker</a>.</span> + + git + </h2> + + +</header> + + +<article> + <div class="container-overview"> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<hr> +<dt> + <h4 class="name" id=".branch"><span class="type-signature"><static> </span>branch()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>branch</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".branch"><span class="type-signature"><static> </span>branch()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>branch</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitEntry"><span class="type-signature"><static> </span>commitEntry(options)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitEntry</p> + </div> + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params table table-striped"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>options</code></td> + + + <td class="type"> + + +<span class="param-type">object</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitEntry"><span class="type-signature"><static> </span>commitEntry(options)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitEntry</p> + </div> + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params table table-striped"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>options</code></td> + + + <td class="type"> + + +<span class="param-type">object</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitMessage"><span class="type-signature"><static> </span>commitMessage()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitMessage</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitMessage"><span class="type-signature"><static> </span>commitMessage()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitMessage</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitSha"><span class="type-signature"><static> </span>commitSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitSha"><span class="type-signature"><static> </span>commitSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".shortSha"><span class="type-signature"><static> </span>shortSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>shortSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".shortSha"><span class="type-signature"><static> </span>shortSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>shortSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + + <h1 class="page-title">Namespace: git</h1> +<section> + +<header> + + <h2> + <span class="ancestors"><a href="faker.html">faker</a>.</span> + + git + </h2> + + +</header> + + +<article> + <div class="container-overview"> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<hr> +<dt> + <h4 class="name" id=".branch"><span class="type-signature"><static> </span>branch()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>branch</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".branch"><span class="type-signature"><static> </span>branch()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>branch</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitEntry"><span class="type-signature"><static> </span>commitEntry(options)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitEntry</p> + </div> + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params table table-striped"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>options</code></td> + + + <td class="type"> + + +<span class="param-type">object</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitEntry"><span class="type-signature"><static> </span>commitEntry(options)</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitEntry</p> + </div> + + + + + + + + + <h5>Parameters:</h5> + + +<table class="params table table-striped"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>options</code></td> + + + <td class="type"> + + +<span class="param-type">object</span> + + + + + </td> + + + + + + <td class="description last"></td> + </tr> + + + </tbody> +</table> + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitMessage"><span class="type-signature"><static> </span>commitMessage()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitMessage</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitMessage"><span class="type-signature"><static> </span>commitMessage()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitMessage</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitSha"><span class="type-signature"><static> </span>commitSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".commitSha"><span class="type-signature"><static> </span>commitSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>commitSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".shortSha"><span class="type-signature"><static> </span>shortSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>shortSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + + +<hr> +<dt> + <h4 class="name" id=".shortSha"><span class="type-signature"><static> </span>shortSha()</h4> + + +</dt> +<dd> + + + <div class="description"> + <p>shortSha</p> + </div> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + + + +</dd> + + </dl> + + + + + +</article> + +</section> + + + + + </div> + </div> + + <div class="clearfix"></div> + + + <div class="col-md-3"> + <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> + </div> + + +</div> +</div> + + + <div class="modal fade" id="searchResults"> + <div class="modal-dialog"> + <div class="modal-content"> + <div class="modal-header"> + <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> + <h4 class="modal-title">Search results</h4> + </div> + <div class="modal-body"></div> + <div class="modal-footer"> + <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> + </div> + </div><!-- /.modal-content --> + </div><!-- /.modal-dialog --> + </div> + + +<footer> + + +<span class="jsdoc-message"> + Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.5</a> + + on 2020-08-22T21:07:02-04:00 + + using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. +</span> +</footer> + +<script src="scripts/docstrap.lib.js"></script> +<script src="scripts/toc.js"></script> + + <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script> + + +<script> +$( function () { + $( "[id*='$']" ).each( function () { + var $this = $( this ); + + $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); + } ); + + $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () { + var $this = $( this ); + + var example = $this.find( "code" ); + exampleText = example.html(); + var lang = /{@lang (.*?)}/.exec( exampleText ); + if ( lang && lang[1] ) { + exampleText = exampleText.replace( lang[0], "" ); + example.html( exampleText ); + lang = lang[1]; + } else { + var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); + lang = langClassMatch ? langClassMatch[1] : "javascript"; + } + + if ( lang ) { + + $this + .addClass( "sunlight-highlight-" + lang ) + .addClass( "linenums" ) + .html( example.html() ); + + } + } ); + + Sunlight.highlightAll( { + lineNumbers : false, + showMenu : true, + enableDoclinks : true + } ); + + $.catchAnchorLinks( { + navbarOffset: 10 + } ); + $( "#toc" ).toc( { + anchorName : function ( i, heading, prefix ) { + return $( heading ).attr( "id" ) || ( prefix + i ); + }, + selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", + showAndHide : false, + smoothScrolling: true + } ); + + $( "#main span[id^='toc']" ).addClass( "toc-shim" ); + $( '.dropdown-toggle' ).dropdown(); + + $( "table" ).each( function () { + var $this = $( this ); + $this.addClass('table'); + } ); + +} ); +</script> + + + +<!--Navigation and Symbol Display--> + + +<!--Google Analytics--> + + + + <script type="text/javascript"> + $(document).ready(function() { + SearcherDisplay.init(); + }); + </script> + + +</body> +</html>
\ No newline at end of file |
