Skip to content

Commit 6854315

Browse files
phmatrayphmatray
committed
documentation: add docs
1 parent 95a71a8 commit 6854315

8 files changed

+232
-0
lines changed

‎docs/api/IVirtualFileSystem.MoveFile(VFSFilePath,VFSFilePath).md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core.Contracts](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Contracts 'Atypical.VirtualFileSystem.Core.Contracts').[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
3+
4+
## IVirtualFileSystem.MoveFile(VFSFilePath, VFSFilePath) Method
5+
6+
Moves a file node from the source path to the destination path.
7+
Both paths must be absolute.
8+
9+
```csharp
10+
Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath sourceFilePath, Atypical.VirtualFileSystem.Core.VFSFilePath destinationFilePath);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath,Atypical.VirtualFileSystem.Core.VFSFilePath).sourceFilePath'></a>
15+
16+
`sourceFilePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
17+
18+
The source path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath,Atypical.VirtualFileSystem.Core.VFSFilePath).destinationFilePath'></a>
21+
22+
`destinationFilePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
23+
24+
The destination path of the file node.
25+
26+
#### Returns
27+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
28+
The file system.

‎docs/api/IVirtualFileSystem.MoveFile(string,string).md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core.Contracts](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Contracts 'Atypical.VirtualFileSystem.Core.Contracts').[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
3+
4+
## IVirtualFileSystem.MoveFile(string, string) Method
5+
6+
Moves a file node from the source path to the destination path.
7+
Both paths must be absolute.
8+
9+
```csharp
10+
Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem MoveFile(string sourceFilePath, string destinationFilePath);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.MoveFile(string,string).sourceFilePath'></a>
15+
16+
`sourceFilePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
17+
18+
The source path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.MoveFile(string,string).destinationFilePath'></a>
21+
22+
`destinationFilePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
23+
24+
The destination path of the file node.
25+
26+
#### Returns
27+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
28+
The file system.

‎docs/api/IVirtualFileSystem.RenameFile(VFSFilePath,string).md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core.Contracts](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Contracts 'Atypical.VirtualFileSystem.Core.Contracts').[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
3+
4+
## IVirtualFileSystem.RenameFile(VFSFilePath, string) Method
5+
6+
Renames a file node at the specified path.
7+
The path must be absolute.
8+
9+
```csharp
10+
Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath filePath, string newName);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).filePath'></a>
15+
16+
`filePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
17+
18+
The path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).newName'></a>
21+
22+
`newName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
23+
24+
The new name of the file node.
25+
26+
#### Returns
27+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
28+
The file system.

‎docs/api/IVirtualFileSystem.RenameFile(string,string).md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core.Contracts](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core.Contracts 'Atypical.VirtualFileSystem.Core.Contracts').[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
3+
4+
## IVirtualFileSystem.RenameFile(string, string) Method
5+
6+
Renames a file node at the specified path.
7+
The path must be absolute.
8+
9+
```csharp
10+
Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem RenameFile(string filePath, string newName);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.RenameFile(string,string).filePath'></a>
15+
16+
`filePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
17+
18+
The path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.RenameFile(string,string).newName'></a>
21+
22+
`newName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
23+
24+
The new name of the file node.
25+
26+
#### Returns
27+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
28+
The file system.

‎docs/api/VFS.MoveFile(VFSFilePath,VFSFilePath).md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS')
3+
4+
## VFS.MoveFile(VFSFilePath, VFSFilePath) Method
5+
6+
Moves a file node from the source path to the destination path.
7+
Both paths must be absolute.
8+
9+
```csharp
10+
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath sourceFilePath, Atypical.VirtualFileSystem.Core.VFSFilePath destinationFilePath);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath,Atypical.VirtualFileSystem.Core.VFSFilePath).sourceFilePath'></a>
15+
16+
`sourceFilePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
17+
18+
The source path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath,Atypical.VirtualFileSystem.Core.VFSFilePath).destinationFilePath'></a>
21+
22+
`destinationFilePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
23+
24+
The destination path of the file node.
25+
26+
Implements [MoveFile(VFSFilePath, VFSFilePath)](IVirtualFileSystem.MoveFile(VFSFilePath,VFSFilePath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath, Atypical.VirtualFileSystem.Core.VFSFilePath)')
27+
28+
#### Returns
29+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
30+
The file system.

‎docs/api/VFS.MoveFile(string,string).md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS')
3+
4+
## VFS.MoveFile(string, string) Method
5+
6+
Moves a file node from the source path to the destination path.
7+
Both paths must be absolute.
8+
9+
```csharp
10+
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem MoveFile(string sourceFilePath, string destinationFilePath);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveFile(string,string).sourceFilePath'></a>
15+
16+
`sourceFilePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
17+
18+
The source path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveFile(string,string).destinationFilePath'></a>
21+
22+
`destinationFilePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
23+
24+
The destination path of the file node.
25+
26+
Implements [MoveFile(string, string)](IVirtualFileSystem.MoveFile(string,string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.MoveFile(string, string)')
27+
28+
#### Returns
29+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
30+
The file system.

‎docs/api/VFS.RenameFile(VFSFilePath,string).md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS')
3+
4+
## VFS.RenameFile(VFSFilePath, string) Method
5+
6+
Renames a file node at the specified path.
7+
The path must be absolute.
8+
9+
```csharp
10+
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath filePath, string newName);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.VFS.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).filePath'></a>
15+
16+
`filePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath')
17+
18+
The path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.VFS.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).newName'></a>
21+
22+
`newName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
23+
24+
The new name of the file node.
25+
26+
Implements [RenameFile(VFSFilePath, string)](IVirtualFileSystem.RenameFile(VFSFilePath,string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath, string)')
27+
28+
#### Returns
29+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
30+
The file system.

‎docs/api/VFS.RenameFile(string,string).md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem')
2+
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS')
3+
4+
## VFS.RenameFile(string, string) Method
5+
6+
Renames a file node at the specified path.
7+
The path must be absolute.
8+
9+
```csharp
10+
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem RenameFile(string filePath, string newName);
11+
```
12+
#### Parameters
13+
14+
<a name='Atypical.VirtualFileSystem.Core.VFS.RenameFile(string,string).filePath'></a>
15+
16+
`filePath` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
17+
18+
The path of the file node.
19+
20+
<a name='Atypical.VirtualFileSystem.Core.VFS.RenameFile(string,string).newName'></a>
21+
22+
`newName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
23+
24+
The new name of the file node.
25+
26+
Implements [RenameFile(string, string)](IVirtualFileSystem.RenameFile(string,string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem.RenameFile(string, string)')
27+
28+
#### Returns
29+
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem')
30+
The file system.

0 commit comments

Comments
 (0)