From 46c1d49759fc7ad86ac7038b630d6efbc71f376f Mon Sep 17 00:00:00 2001 From: Bill Fencken <54144371+bfencken@users.noreply.github.com> Date: Tue, 22 Nov 2022 14:36:00 -0700 Subject: [PATCH] Update 1.22320.1.md --- gendocs/releasenotes/sdk/1.22320.1.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/gendocs/releasenotes/sdk/1.22320.1.md b/gendocs/releasenotes/sdk/1.22320.1.md index aa5d4d9..8d7d4f3 100644 --- a/gendocs/releasenotes/sdk/1.22320.1.md +++ b/gendocs/releasenotes/sdk/1.22320.1.md @@ -5,9 +5,9 @@ This release of the SDK focuses on extension of the SDK to make code management ### Source Code Injection Updates The following updates how the SDK injects source code into a file. -- Have updated the injection process of code into files. You no longer have to provide the file path, framework determines this. -- Have added an overload to AddBeforeAsync functionality to allow you to add directly before the definition of the model ignoring xml documentation. -- Can now directly control code documentation from the SDK. Added the following code management methods to control documentation. +- Have updated the injection process of code into files. Users no longer have to provide the file path, as the framework determines this. +- Have added an overload to AddBeforeAsync functionality to allow users to add directly before the definition of the model ignoring xml documentation. +- Can now directly control code documentation from the SDK. Added the following code management methods to control documentation: - **AddBeforeDocsAsync** - Add source code content before XML documentation. - **AddAfterDocsAsync** - Add source code content after XML documentation. - **ReplaceDocsAsync** - Replaces the XML documentation. @@ -15,38 +15,38 @@ The following updates how the SDK injects source code into a file. ### Model Lookup Updates - **LookupModel** is now obsolete use **GetModel** now. -- Added **GetModel[T]** this allows to set the target type to return instead of having to cast to directly. +- Added **GetModel[T]** this allows users to set the target type to return instead of having to cast to directly. ### C# Source Formatting moved into the SDK -The **CodeFactory.Formatting.CSharp** project has been moved into the SDK. The following additional capabilities were addeed to source formatting for C#. +The **CodeFactory.Formatting.CSharp** project has been moved into the SDK. The following additional capabilities were added to source formatting for C#. - The **NamespaceManager** now supports adding additional using statements after the manager has been loaded. - **CsManualUsingStatement** has been added to formatting to allow adding customizing using statements to the namespace manager. ### C# Property Model Updates -The CsProperty model has added the following capabilities. -- **GetMethod** property has been added to give you direct access to the get accessor and all the code management functions of the method. -- **SetMethod** property has been added to give you direct access to the set accessor and all the code management functions of the method. +The CsProperty model has added the following capabilities: +- **GetMethod** property has been added to give users direct access to the get accessor and all the code management functions of the method. +- **SetMethod** property has been added to give users direct access to the set accessor and all the code management functions of the method. ### C# Enum Model Updates -The CsEnum model has added the the following capabilities. +The CsEnum model has added the following capabilities: - Can now inject code at the beginning of the Enum body. - Can now inject code at the end of the Enum body. - Can now get the source location of the contents of the Enum body. ### C# CsContainer Updates -The CsContainer Types (**Class**,**Interface**, **Structure**) now support nested type definitions, this includes the following. +The CsContainer Types (**Class**,**Interface**, **Structure**) now support nested type definitions, this includes the following: - Class,Interface, Structure, and Enums can be nested in the above container types. ### C# CsMethod Updates -The CSMethod model now provides partial support in definition which includes the following. +The CSMethod model now provides partial support in definition which includes the following: - Method Partial Definition - The capture of the definition of a partial method. - Method Partial Implementation - The capture of the implementation of a partial method. - When getting the list of methods you will get two instance models now. One for the definition and second for the implementation. - CsMethodType has added two additional enums PartialDefinition and PartialImplementation. ### C# Documentation Changes -- XML Documentation for all models is directly captured from source code so the raw documentation is provided. This includes the following. -- Partial implementations will provide the target xml documentation that was provided. +- XML Documentation for all models is directly captured from source code so the raw documentation is provided. This includes the following: +- Partial implementations will provide the target XML documentation that was provided. If documentation was provided in each partial file it will grab the target file the model generation was requested from. ### C# Model Updates