mirror/Meshtastic-Android
1
0 Fork 0
mirror of https://github.com/meshtastic/Meshtastic-Android.git synced 2026-09-14 14:21:32 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
e2a5d97e5c8a2ae264cb60c1dee0f48862acdd1c
Meshtastic-Android/api/feature/docs/org.meshtastic.feature.docs.data/-default-doc-bundle-loader/index.html
T

239 lines
21 KiB
HTML
Raw Blame History

<!doctype html>
<html class="no-js" lang="en">
<head>
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
<title>DefaultDocBundleLoader</title>
<link href="../../../../images/logo-icon.svg" rel="icon" type="image/svg"><script>var pathToRoot = "../../../../";</script>
<script>document.documentElement.classList.replace("no-js", "js");</script>
<script>const storage = localStorage.getItem("dokka-dark-mode")
if (storage == null) {
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
if (osDarkSchemePreferred === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
} else {
const savedDarkMode = JSON.parse(storage)
if (savedDarkMode === true) {
document.getElementsByTagName("html")[0].classList.add("theme-dark")
}
}
</script>
<script type="text/javascript" src="../../../../scripts/sourceset_dependencies.js" async></script>
<link href="../../../../styles/style.css" rel="Stylesheet">
<link href="../../../../styles/main.css" rel="Stylesheet">
<link href="../../../../styles/prism.css" rel="Stylesheet">
<link href="../../../../styles/logo-styles.css" rel="Stylesheet">
<link href="../../../../ui-kit/ui-kit.min.css" rel="Stylesheet">
<script type="text/javascript" src="../../../../scripts/safe-local-storage_blocking.js"></script>
<script type="text/javascript" src="../../../../scripts/navigation-loader.js" async></script>
<script type="text/javascript" src="../../../../scripts/platform-content-handler.js" async></script>
<script type="text/javascript" src="../../../../scripts/main.js" defer></script>
<script type="text/javascript" src="../../../../scripts/prism.js" async></script>
<script type="text/javascript" src="../../../../ui-kit/ui-kit.min.js" defer></script></head>
<body>
<div class="root">
<header class="navigation theme-dark" id="navigation-wrapper" role="banner">
<a class="library-name--link" href="../../../../index.html" tabindex="1">
Meshtastic App
</a> <button class="navigation-controls--btn navigation-controls--btn_toc ui-kit_mobile-only" id="toc-toggle" type="button">Toggle table of contents
</button>
<div class="navigation-controls--break ui-kit_mobile-only"></div>
<div class="library-version" id="library-version">
</div>
<div class="navigation-controls">
<ul class="filter-section filter-section_loading" id="filter-section" aria-label="Target filter">
<button class="platform-tag platform-selector common-like" data-active="" aria-pressed="true" data-filter=":feature:docs/commonMain">common</button>
<div class="dropdown filter-section--dropdown" data-role="dropdown" id="filter-section-dropdown">
<button class="button button_dropdown filter-section--dropdown-toggle" role="combobox" data-role="dropdown-toggle" aria-controls="platform-tags-listbox" aria-haspopup="listbox" aria-expanded="false" aria-label="Toggle source sets"></button>
<ul role="listbox" id="platform-tags-listbox" class="dropdown--list" data-role="dropdown-listbox" aria-label="Target filter">
<div class="dropdown--header"><span>Target filter</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close target filter">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<li role="option" class="dropdown--option platform-selector-option common-like" tabindex="0">
<label class="checkbox">
<input type="checkbox" class="checkbox--input" id=":feature:docs/commonMain" data-filter=":feature:docs/commonMain">
<span class="checkbox--icon"></span>
common
</label>
</li>
</ul>
<div class="dropdown--overlay"></div>
</div>
</ul>
<button class="navigation-controls--btn navigation-controls--btn_theme" id="theme-toggle-button" type="button">Switch theme
</button>
<div class="navigation-controls--btn navigation-controls--btn_search" id="searchBar" role="button">Search in
API
</div>
</div>
</header>
<div id="container">
<nav id="leftColumn" class="sidebar" data-item-type="SECTION" data-item-config="{&quot;defaultSize&quot;: 280, &quot;minSize&quot;: 200, &quot;maxSize&quot;: 400}">
<a class="toc--skip-link" href="#main">Skip to content</a>
<div class="dropdown theme-dark_mobile" data-role="dropdown" id="toc-dropdown">
<ul role="listbox" id="toc-listbox" class="dropdown--list dropdown--list_toc-list" data-role="dropdown-listbox" aria-label="Table of contents">
<div class="dropdown--header">
<span>
Meshtastic App
</span>
<button class="button" data-role="dropdown-toggle" aria-label="Close table of contents">
<i class="ui-kit-icon ui-kit-icon_cross"></i>
</button>
</div>
<div class="sidebar--inner" id="sideMenu"></div>
</ul>
<div class="dropdown--overlay"></div>
</div>
</nav>
<div id="resizer" class="resizer" data-item-type="BAR"></div>
<div id="main" data-item-type="SECTION" role="main">
<div class="main-content" data-page-type="classlike" id="content" pageids="feature-docs::org.meshtastic.feature.docs.data/DefaultDocBundleLoader///PointingToDeclaration//-351812214">
<div class="breadcrumbs"><a href="../../index.html">feature-docs</a><span class="delimiter">/</span><a href="../index.html">org.meshtastic.feature.docs.data</a><span class="delimiter">/</span><span class="current">DefaultDocBundleLoader</span></div>
<div class="cover ">
<h1 class="cover"><span>Default</span><wbr><span>Doc</span><wbr><span>Bundle</span><wbr><span><span>Loader</span></span></h1>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">class </span><a href="index.html">DefaultDocBundleLoader</a> : <a href="../-doc-bundle-loader/index.html">DocBundleLoader</a><span class="source-link-wrapper"><span class="source-link" data-element-type="source-link">(<a href="https://github.com/meshtastic/Meshtastic-Android/blob/main/feature/docs/src/commonMain/kotlin/org/meshtastic/feature/docs/data/DocBundleLoader.kt#L97">source</a>)</span></span></div><p class="paragraph">Default implementation that loads docs from bundled markdown files packaged as Compose Resources under <code class="lang-kotlin">files/docs/</code>.</p><p class="paragraph">User guide titles and keywords are resolved from string resources so Crowdin translations propagate to the in-app index and search. Developer guide entries stay hardcoded English (code-focused audience).</p><p class="paragraph">No cross-locale caching — the bundle rebuilds on each <a href="load.html">load</a> call (~1 ms) so locale changes take effect immediately.</p></div></div>
</div>
<div class="tabbedcontent">
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="CONSTRUCTOR,TYPE,PROPERTY,FUNCTION">Members</button></div>
<div class="tabs-section-body">
<div data-togglable="CONSTRUCTOR">
<h2 class="tableheader">Constructors</h2>
<div class="table"><a data-name="301381223%2FConstructors%2F-351812214" anchor-label="DefaultDocBundleLoader" id="301381223%2FConstructors%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-togglable="CONSTRUCTOR" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-default-doc-bundle-loader.html"><span>Default</span><wbr><span>Doc</span><wbr><span>Bundle</span><wbr><span><span>Loader</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="301381223%2FConstructors%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">constructor</span><span class="token punctuation">(</span><span class="token punctuation">)</span></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="TYPE">
<h2 class="tableheader">Types</h2>
<div class="table"><a data-name="-2042172434%2FClasslikes%2F-351812214" anchor-label="Companion" id="-2042172434%2FClasslikes%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="-companion/index.html"><span><span>Companion</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-2042172434%2FClasslikes%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">object </span><a href="-companion/index.html">Companion</a></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div data-togglable="FUNCTION">
<h2 class="tableheader">Functions</h2>
<div class="table"><a data-name="-901610720%2FFunctions%2F-351812214" anchor-label="hasTranslatedResource" id="-901610720%2FFunctions%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="has-translated-resource.html"><span>has</span><wbr><span>Translated</span><wbr><span><span>Resource</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-901610720%2FFunctions%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="has-translated-resource.html"><span class="token function">hasTranslatedResource</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">pageId<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">locale<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a></div><div class="brief "><p class="paragraph">Check whether a Crowdin-translated resource exists for the given page and locale.</p></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="179268717%2FFunctions%2F-351812214" anchor-label="load" id="179268717%2FFunctions%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="load.html"><span><span>load</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="179268717%2FFunctions%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="load.html"><span class="token function">load</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../org.meshtastic.feature.docs.model/-doc-bundle/index.html">DocBundle</a></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-178617973%2FFunctions%2F-351812214" anchor-label="pagesBySection" id="-178617973%2FFunctions%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="pages-by-section.html"><span>pages</span><wbr><span>By</span><wbr><span><span>Section</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-178617973%2FFunctions%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">override </span><span class="token keyword">fun </span><a href="pages-by-section.html"><span class="token function">pagesBySection</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">section<span class="token operator">: </span><a href="../../org.meshtastic.feature.docs.model/-doc-section/index.html">DocSection</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator">&lt;</span><a href="../../org.meshtastic.feature.docs.model/-doc-page/index.html">DocPage</a><span class="token operator">&gt;</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1056708138%2FFunctions%2F-351812214" anchor-label="readPage" id="-1056708138%2FFunctions%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="read-page.html"><span>read</span><wbr><span><span>Page</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1056708138%2FFunctions%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">open </span><span class="token keyword">suspend override </span><span class="token keyword">fun </span><a href="read-page.html"><span class="token function">readPage</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">pageId<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="../../org.meshtastic.feature.docs.model/-doc-page-content/index.html">DocPageContent</a><span class="token operator">?</span></div></div></div>
</div>
</div>
</div>
</div>
<a data-name="-1278945640%2FFunctions%2F-351812214" anchor-label="readPageLocalized" id="-1278945640%2FFunctions%2F-351812214" data-filterable-set=":feature:docs/commonMain"></a>
<div class="table-row table-row_content" data-filterable-current=":feature:docs/commonMain" data-filterable-set=":feature:docs/commonMain">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="read-page-localized.html"><span>read</span><wbr><span>Page</span><wbr><span><span>Localized</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1278945640%2FFunctions%2F-351812214"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":feature:docs/commonMain"><div class="symbol monospace"><span class="token keyword">suspend </span><span class="token keyword">fun </span><a href="read-page-localized.html"><span class="token function">readPageLocalized</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">pageId<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">locale<span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html">String</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-pair/index.html">Pair</a><span class="token operator">&lt;</span><a href="../../org.meshtastic.feature.docs.model/-doc-page-content/index.html">DocPageContent</a><span class="token operator">?</span><span class="token punctuation">, </span><a href="https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">&gt;</span></div><div class="brief "><p class="paragraph">Load page content with locale awareness. Tries locale-qualified Crowdin resource first, falls back to English. Returns a pair of (content, wasLocalized) for cascade decision.</p></div></div></div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<div class="footer--container">
<a href="#content" id="go-to-top-link" class="footer--button footer--button_go-to-top"></a>
<div class="footer--content">
<div>
<span>Generated by </span>
<a class="footer--link footer--link_external" href="https://github.com/Kotlin/dokka">
Dokka
</a>
<div>© 2026 Copyright</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</body>
</html>
Reference in new issue View Git Blame Copy Permalink