Skip to content

Commit

Permalink
update devela docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joseluis committed Sep 24, 2024
1 parent b60df19 commit 19ea73d
Show file tree
Hide file tree
Showing 28 changed files with 276 additions and 105 deletions.
1 change: 1 addition & 0 deletions libera/.rustc_info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"rustc_fingerprint":1699189189452596855,"outputs":{"15729799797837862367":{"success":true,"status":"","code":0,"stdout":"___\nlib___.rlib\nlib___.so\nlib___.so\nlib___.a\nlib___.so\n/home/joseluis/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu\noff\npacked\nunpacked\n___\ndebug_assertions\nfmt_debug=\"full\"\noverflow_checks\npanic=\"unwind\"\nproc_macro\nrelocation_model=\"pic\"\ntarget_abi=\"\"\ntarget_arch=\"x86_64\"\ntarget_endian=\"little\"\ntarget_env=\"gnu\"\ntarget_family=\"unix\"\ntarget_feature=\"fxsr\"\ntarget_feature=\"sse\"\ntarget_feature=\"sse2\"\ntarget_has_atomic\ntarget_has_atomic=\"16\"\ntarget_has_atomic=\"32\"\ntarget_has_atomic=\"64\"\ntarget_has_atomic=\"8\"\ntarget_has_atomic=\"ptr\"\ntarget_has_atomic_equal_alignment=\"16\"\ntarget_has_atomic_equal_alignment=\"32\"\ntarget_has_atomic_equal_alignment=\"64\"\ntarget_has_atomic_equal_alignment=\"8\"\ntarget_has_atomic_equal_alignment=\"ptr\"\ntarget_has_atomic_load_store\ntarget_has_atomic_load_store=\"16\"\ntarget_has_atomic_load_store=\"32\"\ntarget_has_atomic_load_store=\"64\"\ntarget_has_atomic_load_store=\"8\"\ntarget_has_atomic_load_store=\"ptr\"\ntarget_os=\"linux\"\ntarget_pointer_width=\"64\"\ntarget_thread_local\ntarget_vendor=\"unknown\"\nub_checks\nunix\n","stderr":""},"4614504638168534921":{"success":true,"status":"","code":0,"stdout":"rustc 1.83.0-nightly (04a318787 2024-09-15)\nbinary: rustc\ncommit-hash: 04a318787b39732e306faf5ef6dc584990f4f417\ncommit-date: 2024-09-15\nhost: x86_64-unknown-linux-gnu\nrelease: 1.83.0-nightly\nLLVM version: 19.1.0\n","stderr":""}},"successes":{}}
1 change: 1 addition & 0 deletions libera/.rustdoc_fingerprint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"rustc_vv":"rustc 1.83.0-nightly (04a318787 2024-09-15)\nbinary: rustc\ncommit-hash: 04a318787b39732e306faf5ef6dc584990f4f417\ncommit-date: 2024-09-15\nhost: x86_64-unknown-linux-gnu\nrelease: 1.83.0-nightly\nLLVM version: 19.1.0\n"}
2 changes: 1 addition & 1 deletion libera/doc/devela/_all/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
Includes a file as a reference to a byte array.</div></li><li><div class="item-name"><a class="macro" href="macro.include_str.html" title="macro devela::_all::include_str">include_<wbr>str</a></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from rust&#39;s `core`'><code>core</code></span>
Includes a UTF-8 encoded file as a string.</div></li><li><div class="item-name"><a class="macro" href="macro.info.html" title="macro devela::_all::info">info</a><wbr><span class="stab portability" title="Available on crate feature `log` only"><code>log</code></span></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from `log`'><code>log</code></span>
Logs a message at the indicated level.</div></li><li><div class="item-name"><a class="macro" href="macro.items.html" title="macro devela::_all::items">items</a></div><div class="desc docblock-short">Groups items together and expands them as if they were written directly.</div></li><li><div class="item-name"><a class="macro" href="macro.log.html" title="macro devela::_all::log">log</a><wbr><span class="stab portability" title="Available on crate feature `log` only"><code>log</code></span></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from `log`'><code>log</code></span>
Logs a message at the indicated level.</div></li><li><div class="item-name"><a class="macro" href="macro.mem_size_of_expr.html" title="macro devela::_all::mem_size_of_expr">mem_<wbr>size_<wbr>of_<wbr>expr</a></div><div class="desc docblock-short">Returns the size of an expression in bytes.</div></li><li><div class="item-name"><a class="macro" href="macro.option_env.html" title="macro devela::_all::option_env">option_<wbr>env</a></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from rust&#39;s `core`'><code>core</code></span>
Logs a message at the indicated level.</div></li><li><div class="item-name"><a class="macro" href="macro.mem_size_of_expr.html" title="macro devela::_all::mem_size_of_expr">mem_<wbr>size_<wbr>of_<wbr>expr</a></div><div class="desc docblock-short">Returns the size of an expression in bytes.</div></li><li><div class="item-name"><a class="macro" href="macro.namespace_fns.html" title="macro devela::_all::namespace_fns">namespace_<wbr>fns</a></div><div class="desc docblock-short">Helps re-exporting standalone functions as methods implemented over a type.</div></li><li><div class="item-name"><a class="macro" href="macro.option_env.html" title="macro devela::_all::option_env">option_<wbr>env</a></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from rust&#39;s `core`'><code>core</code></span>
Optionally inspects an environment variable at compile time.</div></li><li><div class="item-name"><a class="macro" href="macro.panic_.html" title="macro devela::_all::panic_">panic_</a></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from rust&#39;s `core`'><code>core</code></span>
Panics the current thread.</div></li><li><div class="item-name"><a class="macro" href="macro.paste.html" title="macro devela::_all::paste">paste</a></div><div class="desc docblock-short"><span class="stab portability" title="re-exported from the `paste` crate"><code>paste</code></span>
Allows to paste identifiers together.</div></li><li><div class="item-name"><a class="macro" href="macro.pin.html" title="macro devela::_all::pin">pin</a></div><div class="desc docblock-short"><span class='stab portability' title='re-exported from rust&#39;s `core`'><code>core</code></span>
Expand Down
11 changes: 11 additions & 0 deletions libera/doc/devela/_all/macro.namespace_fns!.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta http-equiv="refresh" content="0;URL=macro.namespace_fns.html">
<title>Redirection</title>
</head>
<body>
<p>Redirecting to <a href="macro.namespace_fns.html">macro.namespace_fns.html</a>...</p>
<script>location.replace("macro.namespace_fns.html" + location.search + location.hash);</script>
</body>
</html>
53 changes: 53 additions & 0 deletions libera/doc/devela/_all/macro.namespace_fns.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Helps re-exporting standalone functions as methods implemented over a type."><title>namespace_fns in devela::_all - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-405f8b29f52305f8.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="devela" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0-nightly (04a318787 2024-09-15)" data-channel="nightly" data-search-js="search-0cfde64e8ad3a7fe.js" data-settings-js="settings-7e3bb6c46e92e77c.js" ><script src="../../static.files/storage-29b1d5a9048d38fe.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-14659ec02b58af51.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-40f72c9259523cb3.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"><!-- https://katex.org/docs/browser.html#starter-template -->

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-wcIxkf4k558AjM3Yz3BBFQUbk/zgIYC2R0QpeeYb+TwlBVMrlgLqwRjRtGZiK7ww" crossorigin="anonymous">

<!-- The loading of KaTeX is deferred to speed up page rendering -->
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-hIoBPJpTUs74ddyc4bFZSM1TVlQDA60VBbJS0oA934VSz82sBx1X7kSx2ATBDIyd" crossorigin="anonymous"></script>

<!-- To automatically render math in text elements, include the auto-render extension: -->
<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous"
onload="renderMathInElement(document.body);"></script>

<script>
document.addEventListener("DOMContentLoaded", function() {
renderMathInElement(document.body, {
delimiters: [
{left: "$$", right: "$$", display: true},
{left: "\\(", right: "\\)", display: false},
{left: "$", right: "$", display: false},
{left: "\\[", right: "\\]", display: true}
]
});
});
</script>

<!-- https://katex.org/docs/issues.html#css-customization -->
<style>
.katex-display { overflow: hidden; }
.docblock p { overflow-y: hidden; }
</style>

</head><body class="rustdoc macro"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../devela/index.html">devela</a><span class="version">0.22.0-wip</span></h2></div><div class="sidebar-elems"><div id="rustdoc-modnav"><h2><a href="index.html">In devela::<wbr>_<wbr>all</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Macro <a href="../index.html">devela</a>::<wbr><a href="index.html">_all</a>::<wbr><a class="macro" href="#">namespace_fns</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/devela/code/util/namespace.rs.html#9-42">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><pre class="rust item-decl"><span class="macro">macro_rules!</span> namespace_fns {
(
<span class="comment">/* syntax */

// $namespace : the type for namespacing, e.g a struct.
// $( $fn_shared_attrs )+ +)? : optional list of shared attributes.
// $( $fn_attrs )* : optional list of $fn_name attributes.
// $fn_vis : the visibility of the function. E.g. pub.
// $fn_name : the name of the function.
// $( : optional list of
// $arg : function argument name…
// $arg_ty : …and the argument's type.
// ),*
//
</span><span class="macro-nonterminal">$namespace</span>:ty,
$(<span class="attr">#[<span class="macro-nonterminal">$fn_shared_attrs</span>:meta]</span>)*
$(
$(<span class="attr">#[<span class="macro-nonterminal">$fn_attrs</span>:meta]</span>)*
<span class="macro-nonterminal">$fn_vis</span>:vis <span class="kw">fn </span><span class="macro-nonterminal">$fn_name</span>:ident($( <span class="macro-nonterminal">$arg</span>:ident : <span class="macro-nonterminal">$arg_ty</span>:ty ),<span class="kw-2">*</span>) -&gt; <span class="macro-nonterminal">$ret_ty</span>:ty
),*
) =&gt; { ... };
}</pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Helps re-exporting standalone functions as methods implemented over a type.</p>
</div></details></section></div></main></body></html>
Loading

0 comments on commit 19ea73d

Please sign in to comment.