Skip to content

Commit

Permalink
APIリファレンスのアップデート。
Browse files Browse the repository at this point in the history
  • Loading branch information
shimodateakira committed Sep 4, 2024
1 parent c4ccc57 commit 3f79d18
Show file tree
Hide file tree
Showing 45 changed files with 753 additions and 473 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -213,22 +213,6 @@ <h5 class="propertyValue">Property Value</h5>
<tr>
<td><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem-1.html">VirtualItem</a>&lt;T&gt;</td>
<td><p>The <a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem-1.html">VirtualItem&lt;T&gt;</a> corresponding to the specified path.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></td>
<td><p>Thrown when the node is not a <a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem-1.html">VirtualItem&lt;T&gt;</a>.</p>
</td>
</tr>
</tbody>
Expand Down
50 changes: 50 additions & 0 deletions docs/api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,56 @@ <h5 class="propertyValue">Property Value</h5>
<tr>
<td><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualDirectory.html">VirtualDirectory</a></td>
<td><p>The virtual node corresponding to the specified virtual path</p>
</td>
</tr>
</tbody>
</table>
<a id="AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Item_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Item*"></a>
<h4 id="AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Item" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Item">Item</h4>
<div class="markdown level1 summary"><p>Gets the adapter providing operations for virtual items.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public VirtualItemAdapter&lt;T&gt; Item { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItemAdapter-1.html">VirtualItemAdapter</a>&lt;T&gt;</td>
<td><p>An instance of <a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItemAdapter-1.html">VirtualItemAdapter&lt;T&gt;</a></p>
</td>
</tr>
</tbody>
</table>
<a id="AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Link_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Link*"></a>
<h4 id="AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Link" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Link">Link</h4>
<div class="markdown level1 summary"><p>Gets the adapter providing operations for virtual symbolic links.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public VirtualSymbolicLinkAdapter&lt;T&gt; Link { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html">VirtualSymbolicLinkAdapter</a>&lt;T&gt;</td>
<td><p>An instance of <a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html">VirtualSymbolicLinkAdapter&lt;T&gt;</a></p>
</td>
</tr>
</tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,13 +169,13 @@ <h5 class="parameters">Parameters</h5>
<h3 id="properties">Properties
</h3>
<a id="AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item*"></a>
<h4 id="AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_AkiraNetwork_VirtualStorageLibrary_VirtualPath_System_Boolean_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item(AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean)">this[VirtualPath, bool]</h4>
<h4 id="AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_AkiraNetwork_VirtualStorageLibrary_VirtualPath_" data-uid="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item(AkiraNetwork.VirtualStorageLibrary.VirtualPath)">this[VirtualPath]</h4>
<div class="markdown level1 summary"><p>Gets or sets the virtual symbolic link corresponding to the specified path.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public VirtualSymbolicLink this[VirtualPath path, bool followLinks = true] { get; set; }</code></pre>
<pre><code class="lang-csharp hljs">public VirtualSymbolicLink this[VirtualPath path] { get; set; }</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-condensed">
Expand All @@ -191,12 +191,6 @@ <h5 class="parameters">Parameters</h5>
<td><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualPath.html">VirtualPath</a></td>
<td><span class="parametername">path</span></td>
<td><p>The path of the symbolic link.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
<td><span class="parametername">followLinks</span></td>
<td><p>A flag indicating whether to follow links.</p>
</td>
</tr>
</tbody>
Expand All @@ -217,26 +211,10 @@ <h5 class="propertyValue">Property Value</h5>
</tr>
</tbody>
</table>
<h5 id="AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_AkiraNetwork_VirtualStorageLibrary_VirtualPath_System_Boolean__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>To operate on the symbolic link itself, specify <code>followLinks</code> as false.
Note that the default value of this parameter may change in the future.</p>
<h5 id="AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_AkiraNetwork_VirtualStorageLibrary_VirtualPath__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This adapter directly operates on the symbolic link itself and does not resolve the link to its target.
Ensure that this behavior is desired, as any operations will affect the symbolic link rather than the linked item.</p>
</div>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></td>
<td><p>Thrown when the node is not a <a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLink.html">VirtualSymbolicLink</a>.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="AkiraNetwork.VirtualStorageLibrary.Utilities.VirtualTextFormatter.html#AkiraNetwork_VirtualStorageLibrary_Utilities_VirtualTextFormatter_GenerateSingleTableDebugText__1___0_">VirtualTextFormatter.GenerateSingleTableDebugText&lt;T&gt;(T)</a>
Expand Down
10 changes: 10 additions & 0 deletions docs/api/AkiraNetwork.VirtualStorageLibrary.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@ <h4><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem.html">V
<section><p>Represents a virtual item. This class serves as the base class for the
<a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem-1.html">VirtualItem&lt;T&gt;</a> type and is used solely for type checking of
<a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem.html">VirtualItem</a>.</p>
</section>
<h4><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItemAdapter-1.html">VirtualItemAdapter&lt;T&gt;</a></h4>
<section><p>Adapter class to simplify operations on virtual items.
Reduces the need for casting and simplifies code, allowing
users to easily manage specific node types.</p>
</section>
<h4><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualItem-1.html">VirtualItem&lt;T&gt;</a></h4>
<section><p>Represents a virtual item. A virtual item is an object used to manage
Expand Down Expand Up @@ -175,6 +180,11 @@ <h4><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLink
<p>The virtual symbolic link supports the concept of NULL links. When the TargetPath is null,
the link resolution is not performed during path traversal. This feature can be useful when
the target is undefined or dynamically determined.</p>
</section>
<h4><a class="xref" href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html">VirtualSymbolicLinkAdapter&lt;T&gt;</a></h4>
<section><p>Adapter class to simplify operations on virtual symbolic links.
Reduces the need for casting and simplifies code, allowing
users to easily manage specific node types.</p>
</section>
<h3 id="structs">
Structs
Expand Down
6 changes: 6 additions & 0 deletions docs/api/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@
<li>
<a href="AkiraNetwork.VirtualStorageLibrary.VirtualItem.html" name="" title="VirtualItem">VirtualItem</a>
</li>
<li>
<a href="AkiraNetwork.VirtualStorageLibrary.VirtualItemAdapter-1.html" name="" title="VirtualItemAdapter&lt;T&gt;">VirtualItemAdapter&lt;T&gt;</a>
</li>
<li>
<a href="AkiraNetwork.VirtualStorageLibrary.VirtualItem-1.html" name="" title="VirtualItem&lt;T&gt;">VirtualItem&lt;T&gt;</a>
</li>
Expand Down Expand Up @@ -104,6 +107,9 @@
<li>
<a href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLink.html" name="" title="VirtualSymbolicLink">VirtualSymbolicLink</a>
</li>
<li>
<a href="AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html" name="" title="VirtualSymbolicLinkAdapter&lt;T&gt;">VirtualSymbolicLinkAdapter&lt;T&gt;</a>
</li>
</ul>
</li>
<li>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/toc.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/index.json

Large diffs are not rendered by default.

52 changes: 43 additions & 9 deletions docs/xrefmap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4404,6 +4404,23 @@ references:
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).IsValidWildcardPath
nameWithType: VirtualStorage<T>.IsValidWildcardPath
nameWithType.vb: VirtualStorage(Of T).IsValidWildcardPath
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Item
name: Item
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Item
commentId: P:AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Item
fullName: AkiraNetwork.VirtualStorageLibrary.VirtualStorage<T>.Item
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).Item
nameWithType: VirtualStorage<T>.Item
nameWithType.vb: VirtualStorage(Of T).Item
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Item*
name: Item
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Item_
commentId: Overload:AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Item
isSpec: "True"
fullName: AkiraNetwork.VirtualStorageLibrary.VirtualStorage<T>.Item
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).Item
nameWithType: VirtualStorage<T>.Item
nameWithType.vb: VirtualStorage(Of T).Item
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.ItemExists(AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean)
name: ItemExists(VirtualPath, bool)
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_ItemExists_AkiraNetwork_VirtualStorageLibrary_VirtualPath_System_Boolean_
Expand All @@ -4422,6 +4439,23 @@ references:
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).ItemExists
nameWithType: VirtualStorage<T>.ItemExists
nameWithType.vb: VirtualStorage(Of T).ItemExists
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Link
name: Link
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Link
commentId: P:AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Link
fullName: AkiraNetwork.VirtualStorageLibrary.VirtualStorage<T>.Link
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).Link
nameWithType: VirtualStorage<T>.Link
nameWithType.vb: VirtualStorage(Of T).Link
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Link*
name: Link
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_Link_
commentId: Overload:AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.Link
isSpec: "True"
fullName: AkiraNetwork.VirtualStorageLibrary.VirtualStorage<T>.Link
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualStorage(Of T).Link
nameWithType: VirtualStorage<T>.Link
nameWithType.vb: VirtualStorage(Of T).Link
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualStorage`1.LinkDictionary
name: LinkDictionary
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualStorage-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualStorage_1_LinkDictionary
Expand Down Expand Up @@ -5537,15 +5571,15 @@ references:
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter(Of T).New
nameWithType: VirtualSymbolicLinkAdapter<T>.VirtualSymbolicLinkAdapter
nameWithType.vb: VirtualSymbolicLinkAdapter(Of T).New
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item(AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean)
name: this[VirtualPath, bool]
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_AkiraNetwork_VirtualStorageLibrary_VirtualPath_System_Boolean_
commentId: P:AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item(AkiraNetwork.VirtualStorageLibrary.VirtualPath,System.Boolean)
name.vb: this[](VirtualPath, Boolean)
fullName: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter<T>.this[AkiraNetwork.VirtualStorageLibrary.VirtualPath, bool]
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter(Of T).this[](AkiraNetwork.VirtualStorageLibrary.VirtualPath, Boolean)
nameWithType: VirtualSymbolicLinkAdapter<T>.this[VirtualPath, bool]
nameWithType.vb: VirtualSymbolicLinkAdapter(Of T).this[](VirtualPath, Boolean)
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
name: this[VirtualPath]
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_AkiraNetwork_VirtualStorageLibrary_VirtualPath_
commentId: P:AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item(AkiraNetwork.VirtualStorageLibrary.VirtualPath)
name.vb: this[](VirtualPath)
fullName: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter<T>.this[AkiraNetwork.VirtualStorageLibrary.VirtualPath]
fullName.vb: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter(Of T).this[](AkiraNetwork.VirtualStorageLibrary.VirtualPath)
nameWithType: VirtualSymbolicLinkAdapter<T>.this[VirtualPath]
nameWithType.vb: VirtualSymbolicLinkAdapter(Of T).this[](VirtualPath)
- uid: AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter`1.Item*
name: this
href: api/AkiraNetwork.VirtualStorageLibrary.VirtualSymbolicLinkAdapter-1.html#AkiraNetwork_VirtualStorageLibrary_VirtualSymbolicLinkAdapter_1_Item_
Expand Down
Loading

0 comments on commit 3f79d18

Please sign in to comment.