Skip to content

📋 standard metadata updates #5097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
May 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 0 additions & 2 deletions docs/standard/analyzers/api-analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Learn how the .NET API Analyzer can help detect deprecated APIs and
author: oliag
ms.author: mairaw
ms.date: 01/30/2018
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
---
# .NET API analyzer
Expand Down
5 changes: 0 additions & 5 deletions docs/standard/analyzers/framework-analyzer.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
---
title: The .NET Security Analyzers - .NET
description: Learn how to use the .NET Security Analyzers in the .NET Framework Analyzers package to find and address security risks
keywords: .NET, .NET Core
author: billwagner
ms.author: billwagner
ms.date: 01/25/2018
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
ms.devlang: dotnet
---

# The .NET Framework Analyzer

You can use the .NET Framework Analyzer to find potential issues in your .NET Framework-based application code. This analyzer finds potential issues and suggests
Expand Down
5 changes: 0 additions & 5 deletions docs/standard/analyzers/index.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,11 @@
---
title: The Roslyn based Analyzers - .NET
description: Learn about Roslyn based analyzers that find issues and suggest fixes for those issues.
keywords: .NET, .NET Core
author: billwagner
ms.author: billwagner
ms.date: 01/24/2018
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
ms.devlang: dotnet
---

# The Roslyn based Analyzers

Roslyn-based analyzers use the .NET Compiler SDK (Roslyn APIs) to analyze your project's source code to find issues and suggest corrections. Different analyzers look for different classes of issues, ranging from practices that are likely to cause bugs to security concerns to API compatibility.
Expand Down
8 changes: 0 additions & 8 deletions docs/standard/analyzers/portability-analyzer.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
title: The .NET Portability Analyzer - .NET
description: Learn how to use the .NET Portability Analyzer tool to evaluate how portable your code is among the various .NET implementations, including .NET Core, .NET Standard, UWP, and Xamarin.
keywords: .NET, .NET Core
author: blackdwarf
ms.author: mairaw
ms.date: 07/26/2017
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
ms.devlang: dotnet
ms.assetid: 0375250f-5704-4993-a6d5-e21c499cea1e
ms.workload:
- "dotnet"
- "dotnetcore"
---

# The .NET Portability Analyzer

Want to make your libraries multi-platform? Want to see how much work is required to make your application compatible with other .NET implementations and profiles, including .NET Core, .NET Standard, UWP, and Xamarin for iOS, Android, and Mac? The [.NET Portability Analyzer](https://marketplace.visualstudio.com/items?itemName=ConnieYau.NETPortabilityAnalyzer) is a tool that provides you with a detailed report on how flexible your program is across .NET implementations by analyzing assemblies. The Portability Analyzer is offered as a Visual Studio Extension and as a console app.
Expand Down
11 changes: 0 additions & 11 deletions docs/standard/application-essentials.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,12 @@
---
title: ".NET Framework Application Essentials"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
helpviewer_keywords:
- ".NET Framework development"
ms.assetid: 653da4ba-3752-4d1f-a08a-de017dc86ecc
caps.latest.revision: 19
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# .NET Framework Application Essentials
This section of the .NET Framework documentation provides information about basic application development tasks in the .NET Framework.
Expand Down
8 changes: 0 additions & 8 deletions docs/standard/assembly-format.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
title: .NET Assembly File Format
description: Learn about the .NET assembly file format, which is used to describe and contain .NET apps and libraries.
keywords: .NET, .NET Core
author: richlander
ms.author: mairaw
ms.date: 06/20/2016
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
ms.devlang: dotnet
ms.assetid: 6520323e-ff28-4c8a-ba80-e64a413199e6
ms.workload:
- "dotnet"
- "dotnetcore"
---

# .NET Assembly File Format

.NET defines a binary file format - "assembly" - that is used to fully-describe and contain .NET programs. Assemblies are used for the programs themselves as well as any dependent libraries. A .NET program can be executed as one or more assemblies, with no other required artifacts, beyond the appropriate .NET implementation. Native dependencies, including operating system APIs, are a separate concern and are not contained within the .NET assembly format, although are sometimes described with this format (for example, WinRT).
Expand Down
8 changes: 0 additions & 8 deletions docs/standard/async-in-depth.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
title: Async in depth
description: Learn how writing I/O-bound and CPU-bound asynchronous code is straightforward using the .NET Task-based async model.
keywords: .NET, .NET Core, .NET Standard
author: cartermp
ms.author: wiwagn
ms.date: 06/20/2016
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
ms.devlang: dotnet
ms.assetid: 1e38f9d9-8f84-46ee-a15f-199aec4f2e34
ms.workload:
- "dotnet"
- "dotnetcore"
---

# Async in depth

Writing I/O- and CPU-bound asynchronous code is straightforward using the .NET Task-based async model. The model is exposed by the `Task` and `Task<T>` types and the `async` and `await` keywords in C# and Visual Basic. (Language-specific resources are found in the [See also](#see-also) section.) This article explains how to use .NET async and provides insight into the async framework used under the covers.
Expand Down
8 changes: 0 additions & 8 deletions docs/standard/async.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,12 @@
---
title: Async Overview
description: Learn how async programming is a key technique that makes it straightforward to handle blocking I/O and concurrent operations on multiple cores.
keywords: .NET, .NET Core
author: cartermp
ms.author: wiwagn
ms.date: 06/20/2016
ms.topic: article
ms.prod: .net
ms.technology: dotnet-standard
ms.devlang: dotnet
ms.assetid: 1e38e9d9-8284-46ee-a15f-199adc4f26f4
ms.workload:
- "dotnet"
- "dotnetcore"
---

# Async Overview

Not so long ago, apps got faster simply by buying a newer PC or server and then that trend stopped. In fact, it reversed. Mobile phones appeared with 1ghz single core ARM chips and server workloads transitioned to VMs. Users still want responsive UI and business owners want servers that scale with their business. The transition to mobile and cloud and an internet-connected population of >3B users has resulted in a new set of software patterns.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Asynchronous Programming Model (APM)"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
helpviewer_keywords:
- "ending asynchronous operations"
- "starting asynchronous operations"
Expand All @@ -17,13 +11,8 @@ helpviewer_keywords:
- "stopping asynchronous operations"
- "asynchronous programming, beginning operations"
ms.assetid: c9b3501e-6bc6-40f9-8efd-4b6d9e39ccf0
caps.latest.revision: 13
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Asynchronous Programming Model (APM)
An asynchronous operation that uses the <xref:System.IAsyncResult> design pattern is implemented as two methods named **Begin***OperationName* and **End***OperationName* that begin and end the asynchronous operation *OperationName* respectively. For example, the <xref:System.IO.FileStream> class provides the <xref:System.IO.FileStream.BeginRead%2A> and <xref:System.IO.FileStream.EndRead%2A> methods to asynchronously read bytes from a file. These methods implement the asynchronous version of the <xref:System.IO.FileStream.Read%2A> method.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Asynchronous Programming Using Delegates"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
helpviewer_keywords:
- "BeginInvoke method"
- "asynchronous programming, delegates"
Expand All @@ -18,13 +12,8 @@ helpviewer_keywords:
- "delegates [.NET Framework], asynchronous"
- "synchronous calling in asynchronous manner"
ms.assetid: 38a345ca-6963-4436-9608-5c9defef9c64
caps.latest.revision: 16
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Asynchronous Programming Using Delegates
Delegates enable you to call a synchronous method in an asynchronous manner. When you call a delegate synchronously, the `Invoke` method calls the target method directly on the current thread. If the `BeginInvoke` method is called, the common language runtime (CLR) queues the request and returns immediately to the caller. The target method is called asynchronously on a thread from the thread pool. The original thread, which submitted the request, is free to continue executing in parallel with the target method. If a callback method has been specified in the call to the `BeginInvoke` method, the callback method is called when the target method ends. In the callback method, the `EndInvoke` method obtains the return value and any input/output or output-only parameters. If no callback method is specified when calling `BeginInvoke`, `EndInvoke` can be called from the thread that called `BeginInvoke`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Best Practices for Implementing the Event-based Asynchronous Pattern"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
helpviewer_keywords:
- "Event-based Asynchronous Pattern"
- "ProgressChangedEventArgs class"
Expand All @@ -18,13 +12,6 @@ helpviewer_keywords:
- "AsyncOperation class"
- "AsyncCompletedEventArgs class"
ms.assetid: 4acd2094-4f46-4eff-9190-92d0d9ff47db
caps.latest.revision: 8
author: dotnet-bot
ms.author: dotnetcontent
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Best Practices for Implementing the Event-based Asynchronous Pattern
The Event-based Asynchronous Pattern provides you with an effective way to expose asynchronous behavior in classes, with familiar event and delegate semantics. To implement Event-based Asynchronous Pattern, you need to follow some specific behavioral requirements. The following sections describe requirements and guidelines you should consider when you implement a class that follows the Event-based Asynchronous Pattern.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,29 +1,18 @@
---
title: "Blocking Application Execution by Ending an Async Operation"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
helpviewer_keywords:
- "blocks, asynchronous operations"
- "AsyncWaitHandle property"
- "asynchronous programming, blocking applications"
- "blocking application execution"
ms.assetid: cc5e2834-a65b-4df8-b750-7bdb79997fee
caps.latest.revision: 8
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
dev_langs:
- "csharp"
- "vb"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Blocking Application Execution by Ending an Async Operation
Applications that cannot continue to do other work while waiting for the results of an asynchronous operation must block until the operation completes. Use one of the following options to block your application's main thread while waiting for an asynchronous operation to complete:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Blocking Application Execution Using an AsyncWaitHandle"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
dev_langs:
- "csharp"
- "vb"
Expand All @@ -19,13 +13,8 @@ helpviewer_keywords:
- "stopping asynchronous operations"
- "blocking application execution"
ms.assetid: 3e32daf2-8161-4e8f-addd-9fd9ff101b03
caps.latest.revision: 6
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Blocking Application Execution Using an AsyncWaitHandle
Applications that cannot continue to do other work while waiting for the results of an asynchronous operation must block until the operation completes. Use one of the following options to block your application's main thread while waiting for an asynchronous operation to complete:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Calling Asynchronous Methods Using IAsyncResult"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
helpviewer_keywords:
- "ending asynchronous operations"
- "waiting for asynchronous operations"
Expand All @@ -17,13 +11,8 @@ helpviewer_keywords:
- "IAsyncResult interface, calling asynchronous methods"
- "stopping asynchronous operations"
ms.assetid: 07fba116-045b-473c-a0b7-acdbeb49861f
caps.latest.revision: 6
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Calling Asynchronous Methods Using IAsyncResult
Types in the .NET Framework and third-party class libraries can provide methods that allow an application to continue executing while performing asynchronous operations in threads other than the main application thread. The following sections describe and provide code examples that demonstrate the different ways you can call asynchronous methods that use the <xref:System.IAsyncResult> design pattern.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Calling Synchronous Methods Asynchronously"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
dev_langs:
- "csharp"
- "vb"
Expand All @@ -26,13 +20,8 @@ helpviewer_keywords:
- "waiting for asynchronous calls"
- "status information [.NET Framework], asynchronous operations"
ms.assetid: 41972034-92ed-450a-9664-ab93fcc6f1fb
caps.latest.revision: 24
author: "rpetrusha"
ms.author: "ronpet"
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Calling Synchronous Methods Asynchronously
The .NET Framework enables you to call any method asynchronously. To do this you define a delegate with the same signature as the method you want to call; the common language runtime automatically defines `BeginInvoke` and `EndInvoke` methods for this delegate, with the appropriate signatures.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,7 @@
---
title: "Walkthrough: Implementing a Component That Supports the Event-based Asynchronous Pattern"
ms.custom: ""
ms.date: "03/30/2017"
ms.prod: ".net"
ms.reviewer: ""
ms.suite: ""
ms.technology: dotnet-standard
ms.tgt_pltfrm: ""
ms.topic: "article"
dev_langs:
- "csharp"
- "vb"
Expand All @@ -24,13 +18,6 @@ helpviewer_keywords:
- "threading [Windows Forms], asynchronous features"
- "AsyncCompletedEventArgs class"
ms.assetid: 61f676b5-936f-40f6-83ce-f22805ec9c2f
caps.latest.revision: 21
author: dotnet-bot
ms.author: dotnetcontent
manager: "wpickett"
ms.workload:
- "dotnet"
- "dotnetcore"
---
# Walkthrough: Implementing a Component That Supports the Event-based Asynchronous Pattern
If you are writing a class with some operations that may incur noticeable delays, consider giving it asynchronous functionality by implementing the [Event-based Asynchronous Pattern Overview](../../../docs/standard/asynchronous-programming-patterns/event-based-asynchronous-pattern-overview.md).
Expand Down
Loading