Merge pull request #120 from VaclavElias/staging

Update 5 - Improvements

BuildDocs.ps1

@@ -90,6 +90,17 @@ function Ask-IncludeAPI {
     return (Read-Host -Prompt "Your choice (Y/N)").ToLower() -eq "y"
 }
 
+function Ask-UseExistingAPI {
+    Write-Host ""
+    Write-Host -ForegroundColor Cyan "Do you want to use already generated API metadata?"
+    Write-Host ""
+    Write-Host -ForegroundColor Yellow "  [Y] Yes"
+    Write-Host -ForegroundColor Yellow "  [N] No"
+    Write-Host ""
+
+    return (Read-Host -Prompt "Your choice (Y/N)").ToLower() -eq "y"
+}
+
 function Copy-ExtraItems {
 
     Write-Host -ForegroundColor Yellow "Copying versions.json into $($Settings.WebDirectory)/"
@@ -403,6 +414,7 @@ if ($BuildAll)
 {
     $isAllLanguages = $true
     $API = $true
+    $ReuseAPI = $false
 }
 else
 {
@@ -424,6 +436,7 @@ else
     # Ask if the user wants to include API
     if ($isEnLanguage -or $isAllLanguages -or $shouldBuildSelectedLanguage) {
         $API = Ask-IncludeAPI
+        $ReuseAPI = Ask-UseExistingAPI
     } elseif ($isCanceled)
     {
         Write-Host -ForegroundColor Red "Operation canceled by user."
@@ -438,7 +451,9 @@ else
 }
 
 # Generate API doc
-if ($API)
+if ($ReuseAPI) {
+    Write-Host -ForegroundColor Green "Generating API documentation from existing mete data..."
+} elseif ($API)
 {
     $exitCode = Generate-APIDoc
     if($exitCode -ne 0)

en/docfx.json

@@ -94,6 +94,13 @@
         ]
       }
     ],
+    "overwrite": [
+      {
+        "files": [
+          "examples/**/*.md"
+        ]
+      }
+    ],
     "resource": [
       {
         "files": [

en/examples/Stride.Utilities-examples.md

@@ -0,0 +1,57 @@
+---
+uid: Stride.Utilities.Test
+example: [*content]
+---
+
+```csharp
+using System;
+using System.IO;
+using System.Text;
+
+class Test
+{
+
+    public static void Main()
+    {
+        string path = @"c:\temp\MyTest.txt";
+
+        // Delete the file if it exists.
+        if (File.Exists(path))
+        {
+            File.Delete(path);
+        }
+
+        //Create the file.
+        using (FileStream fs = File.Create(path))
+        {
+            AddText(fs, "This is some text");
+            AddText(fs, "This is some more text,");
+            AddText(fs, "\r\nand this is on a new line");
+            AddText(fs, "\r\n\r\nThe following is a subset of characters:\r\n");
+
+            for (int i=1;i < 120;i++)
+            {
+                AddText(fs, Convert.ToChar(i).ToString());
+            }
+        }
+
+        //Open the stream and read it back.
+        using (FileStream fs = File.OpenRead(path))
+        {
+            byte[] b = new byte[1024];
+            UTF8Encoding temp = new UTF8Encoding(true);
+            int readLen;
+            while ((readLen = fs.Read(b,0,b.Length)) > 0)
+            {
+                Console.WriteLine(temp.GetString(b,0,readLen));
+            }
+        }
+    }
+
+    private static void AddText(FileStream fs, string value)
+    {
+        byte[] info = new UTF8Encoding(true).GetBytes(value);
+        fs.Write(info, 0, info.Length);
+    }
+}
+```

en/examples/Stride.Utilities-remarks.md

@@ -0,0 +1,16 @@
+---
+uid: Stride.Utilities.Test
+remarks: *content
+---
+
+Use the FileStream class to read from, write to, open, and close files on a file system, and to manipulate other file-related operating system handles, including pipes, standard input, and standard output. You can use the Read, Write, CopyTo, and Flush methods to perform synchronous operations, or the ReadAsync, WriteAsync, CopyToAsync, and FlushAsync methods to perform asynchronous operations. Use the asynchronous methods to perform resource-intensive file operations without blocking the main thread. This performance consideration is particularly important in a Windows 8.x Store app or desktop app where a time-consuming stream operation can block the UI thread and make your app appear as if it is not working. FileStream buffers input and output for better performance.
+
+> [!NOTE]
+> This type implements the IDisposable interface. When you have finished using the type, you should dispose of it either directly or indirectly. To dispose of the type directly, call its Dispose method in a `try/catch block`. To dispose of it indirectly, use a language construct such as `using` (in C#) or Using (in Visual Basic). For more information, see the "Using an Object that Implements IDisposable" section in the IDisposable interface topic.
+
+The IsAsync property detects whether the file handle was opened asynchronously. You specify this value when you create an instance of the FileStream class using a constructor that has an isAsync, useAsync, or options parameter. When the property is true, the stream utilizes overlapped I/O to perform file operations asynchronously. However, the IsAsync property does not have to be true to call the ReadAsync, WriteAsync, or CopyToAsync method. When the IsAsync property is false and you call the asynchronous read and write operations, the UI thread is still not blocked, but the actual I/O operation is performed synchronously.
+
+The Seek method supports random access to files. Seek allows the read/write position to be moved to any position within the file. This is done with byte offset reference point parameters. The byte offset is relative to the seek reference point, which can be the beginning, the current position, or the end of the underlying file, as represented by the three members of the SeekOrigin enumeration.
+
+> [!CAUTION]
+> Disk files always support random access. At the time of construction, the CanSeek property value is set to true or false depending on the underlying file type. If the underlying file type is FILE_TYPE_DISK, as defined in winbase.h, the CanSeek property value is true. Otherwise, the CanSeek property value is false.

wiki/Understanding-the-Stride-Documentation-Generation-Pipeline.md

@@ -95,6 +95,7 @@ graph TB
     C[Get-UserInput]
     D[Generate-APIDoc]
     E{Ask-IncludeAPI}
+    E1{Ask-UseExistingAPI}
     End[End]
     F[Start-LocalWebsite]
     G[Cancel]
@@ -121,8 +122,10 @@ graph TB
     end
     F1 --> End
     G --> End
-    E -->|Yes| D
+    E -->|Yes| E1
     E -->|No| H
+    E1 -->|Yes| M
+    E1 -->|No| D
     subgraph Documentation Generation
     H --> M
     D --> D1{{docfx metadata}} --> M