<!DOCTYPE HTML> <html lang="en"> <head> <meta charset="UTF-8"> <title>Passes - </title> <meta content="text/html; charset=utf-8" http-equiv="Content-Type"> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="theme-color" content="#ffffff" /> <base href=""> <link rel="stylesheet" href="book.css"> <link href="https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel="stylesheet" type="text/css"> <link href="https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel="stylesheet" type="text/css"> <link rel="shortcut icon" href="favicon.png"> <!-- Font Awesome --> <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"> <link rel="stylesheet" href="highlight.css"> <link rel="stylesheet" href="tomorrow-night.css"> <link rel="stylesheet" href="ayu-highlight.css"> <!-- Custom theme --> <!-- Fetch Clipboard.js from CDN but have a local fallback --> <script src="https://cdn.jsdelivr.net/clipboard.js/1.6.1/clipboard.min.js"></script> <script> if (typeof Clipboard == 'undefined') { document.write(unescape("%3Cscript src='clipboard.min.js'%3E%3C/script%3E")); } </script> </head> <body class="light"> <!-- Work around some values being stored in localStorage wrapped in quotes --> <script type="text/javascript"> try { var theme = localStorage.getItem('mdbook-theme'); var sidebar = localStorage.getItem('mdbook-sidebar'); if (theme.startsWith('"') && theme.endsWith('"')) { localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1)); } if (sidebar.startsWith('"') && sidebar.endsWith('"')) { localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1)); } } catch (e) { } </script> <!-- Set the theme before any content is loaded, prevents flash --> <script type="text/javascript"> var theme; try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { } if (theme === null || theme === undefined) { theme = 'light'; } document.body.className = theme; document.querySelector('html').className = theme; </script> <!-- Hide / unhide sidebar before it is displayed --> <script type="text/javascript"> var sidebar = 'hidden'; if (document.body.clientWidth >= 1080) { try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { } sidebar = sidebar || 'visible'; } document.querySelector('html').classList.add("sidebar-" + sidebar); </script> <nav id="sidebar" class="sidebar" aria-label="Table of contents"> <ol class="chapter"><li><a href="what-is-rustdoc.html"><strong aria-hidden="true">1.</strong> What is rustdoc?</a></li><li><a href="command-line-arguments.html"><strong aria-hidden="true">2.</strong> Command-line arguments</a></li><li><a href="the-doc-attribute.html"><strong aria-hidden="true">3.</strong> The #[doc] attribute</a></li><li><a href="documentation-tests.html"><strong aria-hidden="true">4.</strong> Documentation tests</a></li><li><a href="passes.html" class="active"><strong aria-hidden="true">5.</strong> Passes</a></li></ol> </nav> <div id="page-wrapper" class="page-wrapper"> <div class="page"> <div id="menu-bar" class="menu-bar"> <div id="menu-bar-sticky-container"> <div class="left-buttons"> <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar"> <i class="fa fa-bars"></i> </button> <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list"> <i class="fa fa-paint-brush"></i> </button> <ul id="theme-list" class="theme-popup" aria-label="submenu"> <li><button class="theme" id="light">Light <span class="default">(default)</span></button></li> <li><button class="theme" id="rust">Rust</button></li> <li><button class="theme" id="coal">Coal</button></li> <li><button class="theme" id="navy">Navy</button></li> <li><button class="theme" id="ayu">Ayu</button></li> </ul> </div> <h1 class="menu-title"></h1> <div class="right-buttons"> <a href="print.html" title="Print this book" aria-label="Print this book"> <i id="print-button" class="fa fa-print"></i> </a> </div> </div> </div> <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM --> <script type="text/javascript"> document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible'); document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible'); Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) { link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1); }); </script> <div id="content" class="content"> <main> <a class="header" href="passes.html#passes" id="passes"><h1>Passes</h1></a> <p>Rustdoc has a concept called "passes". These are transformations that <code>rustdoc</code> runs on your documentation before producing its final output.</p> <p>In addition to the passes below, check out the docs for these flags:</p> <ul> <li><a href="command-line-arguments.html#--passes-add-more-rustdoc-passes"><code>--passes</code></a></li> <li><a href="command-line-arguments.html#--no-defaults-dont-run-default-passes"><code>--no-defaults</code></a></li> </ul> <a class="header" href="passes.html#default-passes" id="default-passes"><h2>Default passes</h2></a> <p>By default, rustdoc will run some passes, namely:</p> <ul> <li><code>strip-hidden</code></li> <li><code>strip-private</code></li> <li><code>collapse-docs</code></li> <li><code>unindent-comments</code></li> </ul> <p>However, <code>strip-private</code> implies <code>strip-private-imports</code>, and so effectively, all passes are run by default.</p> <a class="header" href="passes.html#strip-hidden" id="strip-hidden"><h2><code>strip-hidden</code></h2></a> <p>This pass implements the <code>#[doc(hidden)]</code> attribute. When this pass runs, it checks each item, and if it is annotated with this attribute, it removes it from <code>rustdoc</code>'s output.</p> <p>Without this pass, these items will remain in the output.</p> <a class="header" href="passes.html#unindent-comments" id="unindent-comments"><h2><code>unindent-comments</code></h2></a> <p>When you write a doc comment like this:</p> <pre><code class="language-rust ignore">/// This is a documentation comment. </code></pre> <p>There's a space between the <code>///</code> and that <code>T</code>. That spacing isn't intended to be a part of the output; it's there for humans, to help separate the doc comment syntax from the text of the comment. This pass is what removes that space.</p> <p>The exact rules are left under-specified so that we can fix issues that we find.</p> <p>Without this pass, the exact number of spaces is preserved.</p> <a class="header" href="passes.html#collapse-docs" id="collapse-docs"><h2><code>collapse-docs</code></h2></a> <p>With this pass, multiple <code>#[doc]</code> attributes are converted into one single documentation string.</p> <p>For example:</p> <pre><code class="language-rust ignore">#[doc = "This is the first line."] #[doc = "This is the second line."] </code></pre> <p>Gets collapsed into a single doc string of</p> <pre><code class="language-text">This is the first line. This is the second line. </code></pre> <a class="header" href="passes.html#strip-private" id="strip-private"><h2><code>strip-private</code></h2></a> <p>This removes documentation for any non-public items, so for example:</p> <pre><code class="language-rust ignore">/// These are private docs. struct Private; /// These are public docs. pub struct Public; </code></pre> <p>This pass removes the docs for <code>Private</code>, since they're not public.</p> <p>This pass implies <code>strip-priv-imports</code>.</p> <a class="header" href="passes.html#strip-priv-imports" id="strip-priv-imports"><h2><code>strip-priv-imports</code></h2></a> <p>This is the same as <code>strip-private</code>, but for <code>extern crate</code> and <code>use</code> statements instead of items.</p> </main> <nav class="nav-wrapper" aria-label="Page navigation"> <!-- Mobile navigation buttons --> <a rel="prev" href="documentation-tests.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> <i class="fa fa-angle-left"></i> </a> <div style="clear: both"></div> </nav> </div> </div> <nav class="nav-wide-wrapper" aria-label="Page navigation"> <a href="documentation-tests.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left"> <i class="fa fa-angle-left"></i> </a> </nav> </div> <!-- Local fallback for Font Awesome --> <script> if (getComputedStyle(document.querySelector(".fa")).fontFamily !== "FontAwesome") { var link = document.createElement('link'); link.rel = 'stylesheet'; link.type = 'text/css'; link.href = '_FontAwesome/css/font-awesome.css'; document.head.insertBefore(link, document.head.firstChild) } </script> <script src="highlight.js"></script> <script src="book.js"></script> <!-- Custom JS script --> </body> </html>