Skip to content

Commit 3488ab1

Browse files
phmatrayphmatray
authored
Merge pull request #12 from Atypical-Consulting/9-create-documentation-on-github-page
Create api documentation
2 parents cb0df71 + f8a04d0 commit 3488ab1

File tree

135 files changed

+2771
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

135 files changed

+2771
-3
lines changed

‎Atypical.VirtualFileSystem.sln‎

Lines changed: 137 additions & 0 deletions
Large diffs are not rendered by default.

‎README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -153,10 +153,9 @@ string tree = vfs.ToString();
153153

154154
## 📄 Documentation
155155

156-
The documentation is still a work in progress.
156+
**Virtual File System** provides a complete documentation of the library available in the [`./doc/api`](./doc/api) folder.
157157

158-
One goal of **Virtual File System** is to provide a complete documentation of the library on **GitHub Pages**. For now,
159-
you can read the XML documentation generated on build.
158+
The documentation is generated using [Doraku's DefaultDocumentation](https://github.com/Doraku/DefaultDocumentation) tool.
160159

161160
All summaries are written in English. If you want to help us translate the documentation, please open an issue to
162161
discuss it.

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.CreationTime.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode.CreationTime Property
5+
6+
Gets the creation time of the node.
7+
8+
```csharp
9+
public System.DateTimeOffset CreationTime { get; }
10+
```
11+
12+
Implements [CreationTime](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.CreationTime.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.CreationTime')
13+
14+
#### Property Value
15+
[System.DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/System.DateTimeOffset 'System.DateTimeOffset')

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsDirectory.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode.IsDirectory Property
5+
6+
Indicates whether the node is a directory.
7+
8+
```csharp
9+
public abstract bool IsDirectory { get; }
10+
```
11+
12+
Implements [IsDirectory](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsDirectory.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsDirectory')
13+
14+
#### Property Value
15+
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsFile.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode.IsFile Property
5+
6+
Indicates whether the node is a file.
7+
8+
```csharp
9+
public abstract bool IsFile { get; }
10+
```
11+
12+
Implements [IsFile](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsFile.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.IsFile')
13+
14+
#### Property Value
15+
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastAccessTime.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode.LastAccessTime Property
5+
6+
Gets the last access time of the node.
7+
8+
```csharp
9+
public System.DateTimeOffset LastAccessTime { get; }
10+
```
11+
12+
Implements [LastAccessTime](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastAccessTime.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastAccessTime')
13+
14+
#### Property Value
15+
[System.DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/System.DateTimeOffset 'System.DateTimeOffset')

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastWriteTime.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode.LastWriteTime Property
5+
6+
Gets the last write time of the node.
7+
8+
```csharp
9+
public System.DateTimeOffset LastWriteTime { get; }
10+
```
11+
12+
Implements [LastWriteTime](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastWriteTime.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.LastWriteTime')
13+
14+
#### Property Value
15+
[System.DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/System.DateTimeOffset 'System.DateTimeOffset')

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.Path.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode.Path Property
5+
6+
Gets the creation time of the node.
7+
8+
```csharp
9+
public abstract Atypical.VirtualFileSystem.Core.Abstractions.VFSPath Path { get; }
10+
```
11+
12+
Implements [Path](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.Path.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.Path')
13+
14+
#### Property Value
15+
[VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath')

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions').[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')
3+
4+
## VFSNode(VFSPath) Constructor
5+
6+
Initializes a new instance of the [VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') class.
7+
This constructor is used by derived classes.
8+
9+
```csharp
10+
protected VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath path);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).path'></a>
15+
16+
`path` [VFSPath](Atypical.VirtualFileSystem.Core.Abstractions.VFSPath.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSPath')
17+
18+
The path of the node.

‎doc/api/Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
#### [Atypical.VirtualFileSystem.Core](Atypical.VirtualFileSystem.Core.md 'Atypical.VirtualFileSystem.Core')
2+
### [Atypical.VirtualFileSystem.Core.Abstractions](Atypical.VirtualFileSystem.Core.Abstractions.md 'Atypical.VirtualFileSystem.Core.Abstractions')
3+
4+
## VFSNode Class
5+
6+
Represents a node in a virtual file system.
7+
A node can be a file or a directory.
8+
9+
```csharp
10+
public abstract class VFSNode :
11+
Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode,
12+
System.IEquatable<Atypical.VirtualFileSystem.Core.Abstractions.VFSNode>
13+
```
14+
15+
Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; VFSNode
16+
17+
Derived
18+
&#8627; [DirectoryNode](Atypical.VirtualFileSystem.Core.Models.DirectoryNode.md 'Atypical.VirtualFileSystem.Core.Models.DirectoryNode')
19+
&#8627; [FileNode](Atypical.VirtualFileSystem.Core.Models.FileNode.md 'Atypical.VirtualFileSystem.Core.Models.FileNode')
20+
21+
Implements [IVirtualFileSystemNode](Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystemNode'), [System.IEquatable&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')
22+
23+
| Constructors | |
24+
| :--- | :--- |
25+
| [VFSNode(VFSPath)](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath).md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.VFSNode(Atypical.VirtualFileSystem.Core.Abstractions.VFSPath)') | Initializes a new instance of the [VFSNode](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode') class.<br/>This constructor is used by derived classes. |
26+
27+
| Properties | |
28+
| :--- | :--- |
29+
| [CreationTime](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.CreationTime.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.CreationTime') | Gets the creation time of the node. |
30+
| [IsDirectory](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsDirectory.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsDirectory') | Indicates whether the node is a directory. |
31+
| [IsFile](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsFile.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.IsFile') | Indicates whether the node is a file. |
32+
| [LastAccessTime](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastAccessTime.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastAccessTime') | Gets the last access time of the node. |
33+
| [LastWriteTime](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastWriteTime.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.LastWriteTime') | Gets the last write time of the node. |
34+
| [Path](Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.Path.md 'Atypical.VirtualFileSystem.Core.Abstractions.VFSNode.Path') | Gets the creation time of the node. |

0 commit comments

Comments
 (0)