-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: fix warnings relative to the documentation
- Loading branch information
Showing
14 changed files
with
225 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.CreateDirectory(VFSDirectoryPath) Method | ||
|
||
Creates a directory node at the specified path. | ||
The path must be absolute. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem CreateDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath directoryPath); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.CreateDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath).directoryPath'></a> | ||
|
||
`directoryPath` [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath') | ||
|
||
The path of the directory node. | ||
|
||
Implements [CreateDirectory(VFSDirectoryPath)](IVFSCreate.CreateDirectory(VFSDirectoryPath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSCreate.CreateDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The file system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.CreateFile(VFSFilePath, string) Method | ||
|
||
Creates a file node at the specified path. | ||
The path must be absolute. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem CreateFile(Atypical.VirtualFileSystem.Core.VFSFilePath filePath, string? content=null); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.CreateFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).filePath'></a> | ||
|
||
`filePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') | ||
|
||
The path of the file node. | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.CreateFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).content'></a> | ||
|
||
`content` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
||
The content of the file node. | ||
|
||
Implements [CreateFile(VFSFilePath, string)](IVFSCreate.CreateFile(VFSFilePath,string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSCreate.CreateFile(Atypical.VirtualFileSystem.Core.VFSFilePath, string)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The file system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.DeleteDirectory(VFSDirectoryPath) Method | ||
|
||
Deletes a directory node at the specified path. | ||
The path must be absolute. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem DeleteDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath directoryPath); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.DeleteDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath).directoryPath'></a> | ||
|
||
`directoryPath` [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath') | ||
|
||
The path of the directory node. | ||
|
||
Implements [DeleteDirectory(VFSDirectoryPath)](IVFSDelete.DeleteDirectory(VFSDirectoryPath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSDelete.DeleteDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The file system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.DeleteFile(VFSFilePath) Method | ||
|
||
Deletes a file node at the specified path. | ||
The path must be absolute. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem DeleteFile(Atypical.VirtualFileSystem.Core.VFSFilePath filePath); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.DeleteFile(Atypical.VirtualFileSystem.Core.VFSFilePath).filePath'></a> | ||
|
||
`filePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') | ||
|
||
The path of the file node. | ||
|
||
Implements [DeleteFile(VFSFilePath)](IVFSDelete.DeleteFile(VFSFilePath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSDelete.DeleteFile(Atypical.VirtualFileSystem.Core.VFSFilePath)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The file system. |
29 changes: 29 additions & 0 deletions
29
docs/api/VFS.MoveDirectory(VFSDirectoryPath,VFSDirectoryPath).md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.MoveDirectory(VFSDirectoryPath, VFSDirectoryPath) Method | ||
|
||
Moves a directory from one location to another. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem MoveDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath sourceDirectoryPath, Atypical.VirtualFileSystem.Core.VFSDirectoryPath destinationDirectoryPath); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath,Atypical.VirtualFileSystem.Core.VFSDirectoryPath).sourceDirectoryPath'></a> | ||
|
||
`sourceDirectoryPath` [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath') | ||
|
||
The source directory path. | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath,Atypical.VirtualFileSystem.Core.VFSDirectoryPath).destinationDirectoryPath'></a> | ||
|
||
`destinationDirectoryPath` [VFSDirectoryPath](VFSDirectoryPath.md 'Atypical.VirtualFileSystem.Core.VFSDirectoryPath') | ||
|
||
The destination directory path. | ||
|
||
Implements [MoveDirectory(VFSDirectoryPath, VFSDirectoryPath)](IVFSMove.MoveDirectory(VFSDirectoryPath,VFSDirectoryPath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSMove.MoveDirectory(Atypical.VirtualFileSystem.Core.VFSDirectoryPath, Atypical.VirtualFileSystem.Core.VFSDirectoryPath)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The virtual file system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.MoveFile(VFSFilePath, VFSFilePath) Method | ||
|
||
Moves a file node from the source path to the destination path. | ||
Both paths must be absolute. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath sourceFilePath, Atypical.VirtualFileSystem.Core.VFSFilePath destinationFilePath); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath,Atypical.VirtualFileSystem.Core.VFSFilePath).sourceFilePath'></a> | ||
|
||
`sourceFilePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') | ||
|
||
The source path of the file node. | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath,Atypical.VirtualFileSystem.Core.VFSFilePath).destinationFilePath'></a> | ||
|
||
`destinationFilePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') | ||
|
||
The destination path of the file node. | ||
|
||
Implements [MoveFile(VFSFilePath, VFSFilePath)](IVFSMove.MoveFile(VFSFilePath,VFSFilePath).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSMove.MoveFile(Atypical.VirtualFileSystem.Core.VFSFilePath, Atypical.VirtualFileSystem.Core.VFSFilePath)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The file system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
#### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md 'VirtualFileSystem') | ||
### [Atypical.VirtualFileSystem.Core](VirtualFileSystem.md#Atypical.VirtualFileSystem.Core 'Atypical.VirtualFileSystem.Core').[VFS](VFS.md 'Atypical.VirtualFileSystem.Core.VFS') | ||
|
||
## VFS.RenameFile(VFSFilePath, string) Method | ||
|
||
Renames a file node at the specified path. | ||
The path must be absolute. | ||
|
||
```csharp | ||
public Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath filePath, string newName); | ||
``` | ||
#### Parameters | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).filePath'></a> | ||
|
||
`filePath` [VFSFilePath](VFSFilePath.md 'Atypical.VirtualFileSystem.Core.VFSFilePath') | ||
|
||
The path of the file node. | ||
|
||
<a name='Atypical.VirtualFileSystem.Core.VFS.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath,string).newName'></a> | ||
|
||
`newName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String') | ||
|
||
The new name of the file node. | ||
|
||
Implements [RenameFile(VFSFilePath, string)](IVFSRename.RenameFile(VFSFilePath,string).md 'Atypical.VirtualFileSystem.Core.Contracts.IVFSRename.RenameFile(Atypical.VirtualFileSystem.Core.VFSFilePath, string)') | ||
|
||
#### Returns | ||
[IVirtualFileSystem](IVirtualFileSystem.md 'Atypical.VirtualFileSystem.Core.Contracts.IVirtualFileSystem') | ||
The file system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.