425 lines
12 KiB
HTML
425 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
|
|
<!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
|
|
<!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
|
|
<!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
|
|
<!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
|
|
|
|
|
|
<title>Contributing Documentation - Binary Ninja Documentation</title>
|
|
|
|
|
|
|
|
<link rel="canonical" href="https://docs.binary.ninja/dev/documentation/index.html">
|
|
|
|
|
|
<meta name="author" content="Vector 35 LLC">
|
|
|
|
|
|
<meta property="og:url" content="https://docs.binary.ninja/dev/documentation/index.html">
|
|
<meta property="og:title" content="Binary Ninja Documentation">
|
|
<meta property="og:image" content="https://docs.binary.ninja/dev/documentation/index.html/../../images/logo.png">
|
|
<meta name="apple-mobile-web-app-title" content="Binary Ninja Documentation">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
|
|
|
|
<link rel="apple-touch-icon" href="../../images/logo.png">
|
|
|
|
|
|
<link rel="shortcut icon" type="image/x-icon" href="../../../../favicon.ico">
|
|
<link rel="icon" type="image/x-icon" href="../../../../favicon.ico">
|
|
<style>
|
|
@font-face {
|
|
font-family: 'Icon';
|
|
src: url('../../assets/fonts/icon.eot?52m981');
|
|
src: url('../../assets/fonts/icon.eot?#iefix52m981')
|
|
format('embedded-opentype'),
|
|
url('../../assets/fonts/icon.woff?52m981')
|
|
format('woff'),
|
|
url('../../assets/fonts/icon.ttf?52m981')
|
|
format('truetype'),
|
|
url('../../assets/fonts/icon.svg?52m981#icon')
|
|
format('svg');
|
|
font-weight: normal;
|
|
font-style: normal;
|
|
}
|
|
</style>
|
|
<link rel="stylesheet" href="../../assets/stylesheets/application-a422ff04cc.css">
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Ubuntu:400,700|Ubuntu+Mono">
|
|
<style>
|
|
body, input {
|
|
font-family: 'Ubuntu', Helvetica, Arial, sans-serif;
|
|
}
|
|
pre, code {
|
|
font-family: 'Ubuntu Mono', 'Courier New', 'Courier', monospace;
|
|
}
|
|
</style>
|
|
|
|
|
|
<link rel="stylesheet" href="../../docs.css?1492471077">
|
|
|
|
<script src="../../assets/javascripts/modernizr-4ab42b99fd.js"></script>
|
|
|
|
</head>
|
|
|
|
|
|
|
|
<body class=" ">
|
|
|
|
<div class="backdrop">
|
|
<div class="backdrop-paper"></div>
|
|
</div>
|
|
<input class="toggle" type="checkbox" id="toggle-drawer">
|
|
<input class="toggle" type="checkbox" id="toggle-search">
|
|
<label class="toggle-button overlay" for="toggle-drawer"></label>
|
|
<header class="header">
|
|
<nav aria-label="Header">
|
|
<div class="bar default">
|
|
<div class="button button-menu" role="button" aria-label="Menu">
|
|
<label class="toggle-button icon icon-menu" for="toggle-drawer">
|
|
<span></span>
|
|
</label>
|
|
</div>
|
|
<div class="stretch">
|
|
<div class="title">
|
|
|
|
<span class="path">
|
|
|
|
|
|
Developer Guide <i class="icon icon-link"></i>
|
|
|
|
|
|
</span>
|
|
|
|
Contributing Documentation
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
<div class="bar search">
|
|
<div class="button button-close" role="button" aria-label="Close">
|
|
<label class="toggle-button icon icon-back" for="toggle-search"></label>
|
|
</div>
|
|
<div class="stretch">
|
|
<div class="field">
|
|
<input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
|
|
</div>
|
|
</div>
|
|
<div class="button button-reset" role="button" aria-label="Search">
|
|
<button class="toggle-button icon icon-close" id="reset-search"></button>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
<main class="main">
|
|
|
|
<div class="drawer">
|
|
<nav aria-label="Navigation">
|
|
|
|
<a href="https://binary.ninja/" class="project">
|
|
<div class="banner">
|
|
|
|
<div class="logo">
|
|
<img src="../../images/logo.png">
|
|
</div>
|
|
|
|
<div class="name">
|
|
<strong>
|
|
Binary Ninja Documentation
|
|
<span class="version">
|
|
|
|
</span>
|
|
</strong>
|
|
|
|
</div>
|
|
</div>
|
|
</a>
|
|
<div class="scrollable">
|
|
<div class="wrapper">
|
|
|
|
<div class="toc">
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
<a class="" title="Home" href="../../index.html">
|
|
Home
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<a class="" title="Getting Started Guide" href="../../getting-started/index.html">
|
|
Getting Started Guide
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<span class="section">User Guide</span>
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
<a class="" title="Using and Writing Plugins" href="../../guide/plugins/index.html">
|
|
Using and Writing Plugins
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<a class="" title="Troubleshooting" href="../../guide/troubleshooting/index.html">
|
|
Troubleshooting
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<span class="section">Developer Guide</span>
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
<a class="current" title="Contributing Documentation" href="index.html">
|
|
Contributing Documentation
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
|
|
<li class="anchor">
|
|
<a title="CLA" href="#cla">
|
|
CLA
|
|
</a>
|
|
</li>
|
|
|
|
<li class="anchor">
|
|
<a title="Prerequisites" href="#prerequisites">
|
|
Prerequisites
|
|
</a>
|
|
</li>
|
|
|
|
<li class="anchor">
|
|
<a title="Building" href="#building">
|
|
Building
|
|
</a>
|
|
</li>
|
|
|
|
<li class="anchor">
|
|
<a title="Changing" href="#changing">
|
|
Changing
|
|
</a>
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<a class="" title="BNIL Guide: LLIL" href="../bnil-llil/index.html">
|
|
BNIL Guide: LLIL
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<span class="section">About</span>
|
|
<ul>
|
|
|
|
|
|
<li>
|
|
<a class="" title="License" href="../../about/license/index.html">
|
|
License
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
<li>
|
|
<a class="" title="Open Source" href="../../about/open-source/index.html">
|
|
Open Source
|
|
</a>
|
|
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</div>
|
|
<article class="article">
|
|
<div class="wrapper">
|
|
|
|
<h1 id="building-documentation">Building Documentation<a class="headerlink" href="#building-documentation" title="Permanent link">¶</a></h1>
|
|
<h2 id="cla">CLA<a class="headerlink" href="#cla" title="Permanent link">¶</a></h2>
|
|
<p>To contribute to the Binary Ninja documentation, first sign the <a href="https://binary.ninja/cla.pdf">contribution license agreement</a> and send it to <a href="https://vector35.com/">Vector 35</a>.</p>
|
|
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h2>
|
|
<ul>
|
|
<li><a href="http://www.sphinx-doc.org/en/stable/index.html">sphinx</a></li>
|
|
<li><a href="https://github.com/michaeljones/breathe">breathe</a> (note that on windows, breathe needs a small <a href="https://github.com/michaeljones/breathe/issues/271">fix</a>)</li>
|
|
<li><a href="http://www.mkdocs.org/">mkdocs</a></li>
|
|
<li><a href="http://www.stack.nl/~dimitri/doxygen/">doxygen</a></li>
|
|
</ul>
|
|
<h2 id="building">Building<a class="headerlink" href="#building" title="Permanent link">¶</a></h2>
|
|
<div class="codehilite"><pre><span></span>git clone https://github.com/Vector35/binaryninja-api/
|
|
cd binaryninja-api
|
|
cd api
|
|
mkdocs build
|
|
echo User documentation available in site/
|
|
cd api-docs
|
|
make html
|
|
echo API documentation available in build/html
|
|
</pre></div>
|
|
|
|
|
|
<h2 id="changing">Changing<a class="headerlink" href="#changing" title="Permanent link">¶</a></h2>
|
|
<p>Changing documentation for the API itself is fairly straight forward. Use <a href="https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html">doxygen style comment blocks</a> in C++ and C, and <a href="http://thomas-cokelaer.info/tutorials/sphinx/docstring_python.html">restructured text blocks</a> for python for the source. The user documentation is located in the <code>api/docs/</code> folder and the API documentation is generated from the config in the <code>api/api-docs</code> folder.</p>
|
|
<div class="admonition tip">
|
|
<p class="admonition-title">Tip</p>
|
|
<p>When updating user documentation, the <code>mkdoc serve</code> feature is particularly helpful.</p>
|
|
</div>
|
|
<aside class="copyright" role="note">
|
|
|
|
(<a href="https://creativecommons.org/licenses/by/3.0/">cc</a>) Vector 35 LLC
|
|
|
|
</aside>
|
|
|
|
<footer class="footer">
|
|
|
|
<nav class="pagination" aria-label="Footer">
|
|
<div class="previous">
|
|
|
|
<a href="../../guide/troubleshooting/index.html" title="Troubleshooting">
|
|
<span class="direction">
|
|
Previous
|
|
</span>
|
|
<div class="page">
|
|
<div class="button button-previous" role="button" aria-label="Previous">
|
|
<i class="icon icon-back"></i>
|
|
</div>
|
|
<div class="stretch">
|
|
<div class="title">
|
|
Troubleshooting
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
</div>
|
|
<div class="next">
|
|
|
|
<a href="../bnil-llil/index.html" title="BNIL Guide: LLIL">
|
|
<span class="direction">
|
|
Next
|
|
</span>
|
|
<div class="page">
|
|
<div class="stretch">
|
|
<div class="title">
|
|
BNIL Guide: LLIL
|
|
</div>
|
|
</div>
|
|
<div class="button button-next" role="button" aria-label="Next">
|
|
<i class="icon icon-forward"></i>
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</article>
|
|
<div class="results" role="status" aria-live="polite">
|
|
<div class="scrollable">
|
|
<div class="wrapper">
|
|
<div class="meta"></div>
|
|
<div class="list"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
<script>
|
|
var base_url = '../..';
|
|
var repo_id = '';
|
|
</script>
|
|
<script src="../../assets/javascripts/application-997097ee0c.js"></script>
|
|
|
|
|
|
<script>
|
|
(function(i,s,o,g,r,a,m){
|
|
i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||
|
|
[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;
|
|
m.parentNode.insertBefore(a,m)
|
|
})(window, document,
|
|
'script', 'https://www.google-analytics.com/analytics.js', 'ga');
|
|
/* General initialization */
|
|
ga('create', 'UA-72420552-3', 'docs.binary.ninja');
|
|
ga('set', 'anonymizeIp', true);
|
|
ga('send', 'pageview');
|
|
/* Track outbound links */
|
|
var buttons = document.querySelectorAll('a');
|
|
Array.prototype.map.call(buttons, function(item) {
|
|
if (item.host != document.location.host) {
|
|
item.addEventListener('click', function() {
|
|
var action = item.getAttribute('data-action') || 'follow';
|
|
ga('send', 'event', 'outbound', action, item.href);
|
|
});
|
|
}
|
|
});
|
|
/* Register handler to log search on blur */
|
|
var query = document.querySelector('.query');
|
|
query.addEventListener('blur', function() {
|
|
if (this.value) {
|
|
var path = document.location.pathname;
|
|
ga('send', 'pageview', path + '?q=' + this.value);
|
|
}
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |