Skip to content

Commit af3d6c5

Browse files
kammcelibhal-bot
kammce
and
libhal-bot
authored
Add strong_ptr main API documentation (#42)
Co-authored-by: libhal-bot <libhal-bot@users.noreply.github.com>
1 parent 88fa1de commit af3d6c5

17 files changed

Lines changed: 1654 additions & 54 deletions

‎strong_ptr/main/.doctrees/environment.pickle‎

218 KB
Binary file not shown.

‎strong_ptr/main/.doctrees/strong_ptr/enable_strong_from_this.doctree‎

26.4 KB
Binary file not shown.

‎strong_ptr/main/.doctrees/strong_ptr/exceptions.doctree‎

18.1 KB
Binary file not shown.

‎strong_ptr/main/.doctrees/strong_ptr/monotonic_allocator.doctree‎

82.1 KB
Binary file not shown.

‎strong_ptr/main/.doctrees/strong_ptr/optional_ptr.doctree‎

145 KB
Binary file not shown.

‎strong_ptr/main/.doctrees/strong_ptr/strong_ptr.doctree‎

150 KB
Binary file not shown.

‎strong_ptr/main/.doctrees/strong_ptr/weak_ptr.doctree‎

83.6 KB
Binary file not shown.

‎strong_ptr/main/genindex.html‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,8 +362,135 @@
362362
<h1 id="index">Index</h1>
363363

364364
<div class="genindex-jumpbox">
365+
<a href="#V"><strong>V</strong></a>
365366

366367
</div>
368+
<h2 id="V">V</h2>
369+
<table style="width: 100%" class="indextable genindextable"><tr>
370+
<td style="width: 33%; vertical-align: top;"><ul>
371+
<li><a href="strong_ptr/enable_strong_from_this.html#_CPPv4I0EN2v123enable_strong_from_thisE">v1::enable_strong_from_this (C++ class)</a>
372+
</li>
373+
<li><a href="strong_ptr/enable_strong_from_this.html#_CPPv4N2v123enable_strong_from_this16strong_from_thisEv">v1::enable_strong_from_this::strong_from_this (C++ function)</a>, <a href="strong_ptr/enable_strong_from_this.html#_CPPv4NK2v123enable_strong_from_this16strong_from_thisEv">[1]</a>
374+
</li>
375+
<li><a href="strong_ptr/enable_strong_from_this.html#_CPPv4N2v123enable_strong_from_this14weak_from_thisEv">v1::enable_strong_from_this::weak_from_this (C++ function)</a>, <a href="strong_ptr/enable_strong_from_this.html#_CPPv4NK2v123enable_strong_from_this14weak_from_thisEv">[1]</a>
376+
</li>
377+
<li><a href="strong_ptr/exceptions.html#_CPPv4N2v19exceptionE">v1::exception (C++ class)</a>
378+
</li>
379+
<li><a href="strong_ptr/exceptions.html#_CPPv4NK2v19exception10error_codeEv">v1::exception::error_code (C++ function)</a>
380+
</li>
381+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4I_6size_tEN2v124make_monotonic_allocatorE19monotonic_allocatorI16StorageSizeBytesEv">v1::make_monotonic_allocator (C++ function)</a>
382+
</li>
383+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4I_6size_tEN2v119monotonic_allocatorE">v1::monotonic_allocator (C++ struct)</a>
384+
</li>
385+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocator6m_baseE">v1::monotonic_allocator::m_base (C++ member)</a>
386+
</li>
387+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocator9m_storageE">v1::monotonic_allocator::m_storage (C++ member)</a>
388+
</li>
389+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocator19monotonic_allocatorEv">v1::monotonic_allocator::monotonic_allocator (C++ function)</a>
390+
</li>
391+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocatorcvPNSt3pmr15memory_resourceEEv">v1::monotonic_allocator::operator std::pmr::memory_resource* (C++ function)</a>
392+
</li>
393+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4I0EN2v119monotonic_allocatorcvNSt3pmr21polymorphic_allocatorI1TEEEv">v1::monotonic_allocator::operator std::pmr::polymorphic_allocator&lt;T&gt; (C++ function)</a>
394+
</li>
395+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocatormlEv">v1::monotonic_allocator::operator* (C++ function)</a>
396+
</li>
397+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocatorptEv">v1::monotonic_allocator::operator-&gt; (C++ function)</a>
398+
</li>
399+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v119monotonic_allocator8resourceEv">v1::monotonic_allocator::resource (C++ function)</a>
400+
</li>
401+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_baseE">v1::monotonic_allocator_base (C++ struct)</a>
402+
</li>
403+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_base11do_allocateENSt6size_tENSt6size_tE">v1::monotonic_allocator_base::do_allocate (C++ function)</a>
404+
</li>
405+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_base13do_deallocateEPvNSt6size_tENSt6size_tE">v1::monotonic_allocator_base::do_deallocate (C++ function)</a>
406+
</li>
407+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4NK2v124monotonic_allocator_base11do_is_equalERKNSt3pmr15memory_resourceE">v1::monotonic_allocator_base::do_is_equal (C++ function)</a>
408+
</li>
409+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_base17m_allocated_bytesE">v1::monotonic_allocator_base::m_allocated_bytes (C++ member)</a>
410+
</li>
411+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_base5m_ptrE">v1::monotonic_allocator_base::m_ptr (C++ member)</a>
412+
</li>
413+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_base7m_spaceE">v1::monotonic_allocator_base::m_space (C++ member)</a>
414+
</li>
415+
<li><a href="strong_ptr/monotonic_allocator.html#_CPPv4N2v124monotonic_allocator_baseD0Ev">v1::monotonic_allocator_base::~monotonic_allocator_base (C++ function)</a>
416+
</li>
417+
<li><a href="strong_ptr/exceptions.html#_CPPv4N2v114nullptr_accessE">v1::nullptr_access (C++ struct)</a>
418+
</li>
419+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4I0EN2v112optional_ptrE">v1::optional_ptr (C++ class)</a>
420+
</li>
421+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4IDpEN2v112optional_ptr7emplaceER10strong_ptrI1TEDpRR4Args">v1::optional_ptr::emplace (C++ function)</a>
422+
</li>
423+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptr9has_valueEv">v1::optional_ptr::has_value (C++ function)</a>
424+
</li>
425+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptrcvbEv">v1::optional_ptr::operator bool (C++ function)</a>
426+
</li>
427+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptrcv10strong_ptrI1TEEv">v1::optional_ptr::operator strong_ptr&lt;T&gt; (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptrcv10strong_ptrI1TEEv">[1]</a>
428+
</li>
429+
</ul></td>
430+
<td style="width: 33%; vertical-align: top;"><ul>
431+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4I0EN2v112optional_ptrcv10strong_ptrI1UEEv">v1::optional_ptr::operator strong_ptr&lt;U&gt; (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4I0ENK2v112optional_ptrcv10strong_ptrI1UEEv">[1]</a>
432+
</li>
433+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptrmlEv">v1::optional_ptr::operator* (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptrmlEv">[1]</a>
434+
</li>
435+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptrptEv">v1::optional_ptr::operator-&gt; (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptrptEv">[1]</a>
436+
</li>
437+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4I0EN2v112optional_ptraSER12optional_ptrRK10strong_ptrI1UE">v1::optional_ptr::operator= (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptraSENSt9nullptr_tE">[1]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptraSERK10strong_ptrI1TE">[2]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptraSERK12optional_ptr">[3]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptraSERR12optional_ptr">[4]</a>
438+
</li>
439+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4I0EN2v112optional_ptr12optional_ptrERK10strong_ptrI1UE">v1::optional_ptr::optional_ptr (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr12optional_ptrENSt9nullptr_tE">[1]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr12optional_ptrERK10strong_ptrI1TE">[2]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr12optional_ptrERK12optional_ptr">[3]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr12optional_ptrERR12optional_ptr">[4]</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr12optional_ptrEv">[5]</a>
440+
</li>
441+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr5resetEv">v1::optional_ptr::reset (C++ function)</a>
442+
</li>
443+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr4swapER12optional_ptr">v1::optional_ptr::swap (C++ function)</a>
444+
</li>
445+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptr9use_countEv">v1::optional_ptr::use_count (C++ function)</a>
446+
</li>
447+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptr5valueEv">v1::optional_ptr::value (C++ function)</a>, <a href="strong_ptr/optional_ptr.html#_CPPv4NK2v112optional_ptr5valueEv">[1]</a>
448+
</li>
449+
<li><a href="strong_ptr/optional_ptr.html#_CPPv4N2v112optional_ptrD0Ev">v1::optional_ptr::~optional_ptr (C++ function)</a>
450+
</li>
451+
<li><a href="strong_ptr/exceptions.html#_CPPv4N2v112out_of_rangeE">v1::out_of_range (C++ struct)</a>
452+
</li>
453+
<li><a href="strong_ptr/exceptions.html#_CPPv4N2v112out_of_range4infoE">v1::out_of_range::info (C++ struct)</a>
454+
</li>
455+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4I0EN2v110strong_ptrE">v1::strong_ptr (C++ class)</a>
456+
</li>
457+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4NK2v110strong_ptr13get_allocatorEv">v1::strong_ptr::get_allocator (C++ function)</a>
458+
</li>
459+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr10is_dynamicEv">v1::strong_ptr::is_dynamic (C++ function)</a>
460+
</li>
461+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4NKR2v110strong_ptrmlEv">v1::strong_ptr::operator* (C++ function)</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4NO2v110strong_ptrmlEv">[1]</a>
462+
</li>
463+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4NKR2v110strong_ptrptEv">v1::strong_ptr::operator-&gt; (C++ function)</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4NO2v110strong_ptrptEv">[1]</a>
464+
</li>
465+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4I0EN2v110strong_ptraSER10strong_ptrRK10strong_ptrI1UE">v1::strong_ptr::operator= (C++ function)</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptraSERK10strong_ptr">[1]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptraSERR10strong_ptr">[2]</a>
466+
</li>
467+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4I00_NSt6size_tEEN2v110strong_ptr10strong_ptrERK10strong_ptrI1UEM1UA1N_1ENSt6size_tE">v1::strong_ptr::strong_ptr (C++ function)</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4I00_NSt6size_tEEN2v110strong_ptr10strong_ptrERK10strong_ptrI1UEM1UNSt5arrayI1E1NEENSt6size_tE">[1]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4I0EN2v110strong_ptr10strong_ptrERK10strong_ptrI1UE">[2]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4I0EN2v110strong_ptr10strong_ptrERK10strong_ptrI1UEPKv">[3]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4I0_14non_array_likeEN2v110strong_ptr10strong_ptrERK10strong_ptrI1UEM1U1M">[4]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr10strong_ptrE24unsafe_assume_static_tagR1T">[5]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr10strong_ptrENSt9nullptr_tE">[6]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr10strong_ptrERK10strong_ptr">[7]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr10strong_ptrERR10strong_ptr">[8]</a>, <a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr10strong_ptrEv">[9]</a>
468+
</li>
469+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptr4swapER10strong_ptr">v1::strong_ptr::swap (C++ function)</a>
470+
</li>
471+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4NK2v110strong_ptr9use_countEv">v1::strong_ptr::use_count (C++ function)</a>
472+
</li>
473+
<li><a href="strong_ptr/strong_ptr.html#_CPPv4N2v110strong_ptrD0Ev">v1::strong_ptr::~strong_ptr (C++ function)</a>
474+
</li>
475+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4I0EN2v18weak_ptrE">v1::weak_ptr (C++ class)</a>
476+
</li>
477+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4NK2v18weak_ptr7expiredEv">v1::weak_ptr::expired (C++ function)</a>
478+
</li>
479+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4NK2v18weak_ptr4lockEv">v1::weak_ptr::lock (C++ function)</a>
480+
</li>
481+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptraSERK10strong_ptrI1TE">v1::weak_ptr::operator= (C++ function)</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptraSERK8weak_ptr">[1]</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptraSERR8weak_ptr">[2]</a>
482+
</li>
483+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptr4swapER8weak_ptr">v1::weak_ptr::swap (C++ function)</a>
484+
</li>
485+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4NK2v18weak_ptr9use_countEv">v1::weak_ptr::use_count (C++ function)</a>
486+
</li>
487+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4I0EN2v18weak_ptr8weak_ptrERK10strong_ptrI1UE">v1::weak_ptr::weak_ptr (C++ function)</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4I0EN2v18weak_ptr8weak_ptrERK8weak_ptrI1UE">[1]</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4I0EN2v18weak_ptr8weak_ptrERR8weak_ptrI1UE">[2]</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptr8weak_ptrERK10strong_ptrI1TE">[3]</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptr8weak_ptrERK8weak_ptr">[4]</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptr8weak_ptrERR8weak_ptr">[5]</a>, <a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptr8weak_ptrEv">[6]</a>
488+
</li>
489+
<li><a href="strong_ptr/weak_ptr.html#_CPPv4N2v18weak_ptrD0Ev">v1::weak_ptr::~weak_ptr (C++ function)</a>
490+
</li>
491+
</ul></td>
492+
</tr></table>
493+
367494

368495

369496
</article>

0 commit comments

Comments
 (0)