diff --git a/Makefile b/Makefile index 59360081f..24453e148 100644 --- a/Makefile +++ b/Makefile @@ -18,6 +18,7 @@ prepare: clean: dotnet build -v:n apidoctools.sln /t:clean /p:Configuration=$(CONFIGURATION) rm -rf bin/$(CONFIGURATION) + rm -rf bin/$(CONFIGURATION)-net6.0 check: build check-monodoc check-mdoc diff --git a/Mdoc-ReleaseCheckCI.yml b/Mdoc-ReleaseCheckCI.yml index 8b0be5f44..5cc209c5f 100644 --- a/Mdoc-ReleaseCheckCI.yml +++ b/Mdoc-ReleaseCheckCI.yml @@ -9,7 +9,7 @@ pr: # Variable 'needRunReleaseMdoc' was defined in the Variables tab # Variable 'params' was defined in the Variables tab -# Agent Queue 'Azure Pipelines' was used with unrecognized Agent Specification, vmImage property must be specified to determine image - https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/hosted?view=azure-devops&tabs=yaml#software +# Agent Queue 'Azure Pipelines' was used with unrecognized Agent Specification, vmImage property must be specified to determine image - https://learn.microsoft.com/en-us/azure/devops/pipelines/agents/hosted?view=azure-devops&tabs=yaml#software variables: solution: 'apidoctools.sln' buildConfiguration: 'Release' diff --git a/README.md b/README.md index b6ee05cb7..07110cd92 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # `mdoc` This repository contains the source for the .NET API Reference toolchain ([used - by docs.microsoft.com](https://docs.microsoft.com/en-us/teamblog/announcing-unified-dotnet-experience-on-docs#built-with-open-source-in-mind)) + by learn.microsoft.com](https://learn.microsoft.com/en-us/teamblog/announcing-unified-dotnet-experience-on-docs#built-with-open-source-in-mind)) ## Contribution Guide diff --git a/azure-pipelines.lgtm.yml b/azure-pipelines.lgtm.yml index dc8522526..4207d6315 100644 --- a/azure-pipelines.lgtm.yml +++ b/azure-pipelines.lgtm.yml @@ -1,7 +1,7 @@ # ASP.NET Core (.NET Framework) # Build and test ASP.NET Core projects targeting the full .NET Framework. # Add steps that publish symbols, save build artifacts, and more: -# https://docs.microsoft.com/azure/devops/pipelines/languages/dotnet-core +# https://learn.microsoft.com/azure/devops/pipelines/languages/dotnet-core pr: none trigger: none diff --git a/azure-pipelines.yml b/azure-pipelines.yml index a43218b98..16907e312 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,7 +1,7 @@ # ASP.NET Core (.NET Framework) # Build and test ASP.NET Core projects targeting the full .NET Framework. # Add steps that publish symbols, save build artifacts, and more: -# https://docs.microsoft.com/azure/devops/pipelines/languages/dotnet-core +# https://learn.microsoft.com/azure/devops/pipelines/languages/dotnet-core trigger: - '*' @@ -11,7 +11,7 @@ name: $(SourceBranchName)-$(Date:yyyyMMdd)$(Rev:.r) variables: solution: 'apidoctools.sln' buildConfiguration: 'Release' - mdocPath: 'bin/$(buildConfiguration)' + mdocPath: 'bin/$(buildConfiguration)-net6.0/win-x64' stages: - stage: SDLCheck @@ -120,15 +120,15 @@ stages: condition: and(succeeded(), ne(variables['Build.Reason'], 'PullRequest')) inputs: ConnectedServiceName: 'CodeSigning-APEX' - FolderPath: '$(mdocPath)' + FolderPath: 'bin' UseMinimatch: true signConfigType: inlineSignParams SessionTimeout: '60' MaxConcurrency: '100' MaxRetryAttempts: '5' Pattern: | - *.dll - *.exe + **\*.dll + **\*.exe inlineOperation: | [ { diff --git a/mdoc/Mono.Documentation/Util/AttachedEntitiesHelper.cs b/mdoc/Mono.Documentation/Util/AttachedEntitiesHelper.cs index d8bb3970e..d85989780 100644 --- a/mdoc/Mono.Documentation/Util/AttachedEntitiesHelper.cs +++ b/mdoc/Mono.Documentation/Util/AttachedEntitiesHelper.cs @@ -1,4 +1,4 @@ -using System; +using System; using System.Collections.Generic; using System.Linq; using Mono.Cecil; @@ -55,7 +55,7 @@ private static IEnumerable GetAttachedEvents(TypeDefinit private static bool IsAttachedEvent(FieldDefinition field, Dictionary> methods) { - // https://docs.microsoft.com/en-us/dotnet/framework/wpf/advanced/attached-events-overview + // https://learn.microsoft.com/en-us/dotnet/framework/wpf/advanced/attached-events-overview if (!field.Name.EndsWith(EventConst)) return false; var addMethodName = $"Add{GetEventName(field.Name)}Handler"; @@ -92,11 +92,11 @@ private static bool AreAttachedEventMethodParameters(Collection GetAttachedProperties(Type yield return new AttachedPropertyReference(field); } - foreach (var property in type.Properties.Where(t => t.PropertyType.FullName == Consts.DependencyPropertyFullName - || t.PropertyType.FullName == Consts.DependencyPropertyFullNameWindowsXaml - || t.PropertyType.FullName == Consts.DependencyPropertyFullNameMicrosoftXaml)) - { - if (IsAttachedProperty(property, methods)) - yield return new AttachedPropertyReference(property); + foreach (var property in type.Properties.Where(t => t.PropertyType.FullName == Consts.DependencyPropertyFullName + || t.PropertyType.FullName == Consts.DependencyPropertyFullNameWindowsXaml + || t.PropertyType.FullName == Consts.DependencyPropertyFullNameMicrosoftXaml)) + { + if (IsAttachedProperty(property, methods)) + yield return new AttachedPropertyReference(property); } } private static bool IsAttachedProperty(FieldDefinition field, Dictionary> methods) { - // https://docs.microsoft.com/en-us/dotnet/framework/wpf/advanced/attached-properties-overview + // https://learn.microsoft.com/en-us/dotnet/framework/wpf/advanced/attached-properties-overview // https://github.com/mono/api-doc-tools/issues/63#issuecomment-328995418 if (!field.Name.EndsWith(PropertyConst, StringComparison.Ordinal)) return false; @@ -155,30 +155,30 @@ private static bool IsAttachedProperty(FieldDefinition field, Dictionary> methods) - { - + { + if (!property.Name.EndsWith(PropertyConst, StringComparison.Ordinal)) return false; - var propertyName = GetPropertyName(property.Name); + var propertyName = GetPropertyName(property.Name); var getMethodName = $"Get{propertyName}"; var setMethodName = $"Set{propertyName}"; var hasExistingProperty = property?.DeclaringType?.Properties.Any(p => p.Name.Equals(propertyName, StringComparison.Ordinal) && GetCheckVisible(p.Resolve())); var hasExistingField = property?.DeclaringType?.Fields.Any(f => f.Name.Equals(propertyName, StringComparison.Ordinal) && GetCheckVisible(f.Resolve())); - return !hasExistingProperty.IsTrue() && !hasExistingField.IsTrue() && - // Class X has a static field of type DependencyProperty [Name]Property - (property.PropertyType.FullName == Consts.DependencyPropertyFullName || property.PropertyType.FullName == Consts.DependencyPropertyFullNameWindowsXaml - || property.PropertyType.FullName == Consts.DependencyPropertyFullNameMicrosoftXaml) - - - // Class X also has static methods with the following names: Get[Name] or Set[Name] + return !hasExistingProperty.IsTrue() && !hasExistingField.IsTrue() && + // Class X has a static field of type DependencyProperty [Name]Property + (property.PropertyType.FullName == Consts.DependencyPropertyFullName || property.PropertyType.FullName == Consts.DependencyPropertyFullNameWindowsXaml + || property.PropertyType.FullName == Consts.DependencyPropertyFullNameMicrosoftXaml) + + + // Class X also has static methods with the following names: Get[Name] or Set[Name] && ((methods.ContainsKey(getMethodName) && methods[getMethodName].Any(IsAttachedPropertyGetMethod)) - || (methods.ContainsKey(setMethodName) && methods[setMethodName].Any(IsAttachedPropertySetMethod))); - + || (methods.ContainsKey(setMethodName) && methods[setMethodName].Any(IsAttachedPropertySetMethod))); + } private static bool IsAttachedPropertyGetMethod(MethodDefinition method) @@ -190,7 +190,7 @@ private static bool IsAttachedPropertyGetMethod(MethodDefinition method) // The Get method takes one argument of type DependencyObject(or something IsAssignableTo(DependencyObject), && (IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullName) || - IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinRT) || + IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinRT) || IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinUI)); } @@ -200,15 +200,15 @@ private static bool IsAttachedPropertySetMethod(MethodDefinition method) // The first has type DependencyObject(or IsAssignableTo…), && (IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullName) || - IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinRT) || - IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinUI) || + IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinRT) || + IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyObjectFullNameWinUI) || IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyPropertyFullNameIInputElement) || IsAssignableTo(method.Parameters[0].ParameterType, Consts.DependencyPropertyFullNameObject)) - - // the second has type dp.PropertyType (or IsAssignableTo…). - // && IsAssignableTo(method.Parameters[1].ParameterType, "") - - // It returns void. + + // the second has type dp.PropertyType (or IsAssignableTo…). + // && IsAssignableTo(method.Parameters[1].ParameterType, "") + + // It returns void. && method.ReturnType.FullName == Consts.VoidFullName; } #endregion @@ -222,58 +222,58 @@ private static bool IsAssignableTo(TypeReference type, string targetTypeName) return type.FullName == targetTypeName; return type.FullName == targetTypeName || IsAssignableTo(typeDefenition.BaseType, targetTypeName); - } - - private static bool GetCheckVisible(IMemberDefinition member) - { - if (member == null) - throw new ArgumentNullException("member"); - PropertyDefinition prop = member as PropertyDefinition; - if (prop != null) - return ChkPropertyVisible(prop); - FieldDefinition field = member as FieldDefinition; - if (field != null) - return ChkFieldVisible(field); - return false; - } - + } + + private static bool GetCheckVisible(IMemberDefinition member) + { + if (member == null) + throw new ArgumentNullException("member"); + PropertyDefinition prop = member as PropertyDefinition; + if (prop != null) + return ChkPropertyVisible(prop); + FieldDefinition field = member as FieldDefinition; + if (field != null) + return ChkFieldVisible(field); + return false; + } + private static bool ChkPropertyVisible(PropertyDefinition property) - { - MethodDefinition method; - bool get_visible = false; - bool set_visible = false; - - if ((method = property.GetMethod) != null && - (DocUtils.IsExplicitlyImplemented(method) || - (!method.IsPrivate && !method.IsAssembly && !method.IsFamilyAndAssembly))) - get_visible = true; - - if ((method = property.SetMethod) != null && - (DocUtils.IsExplicitlyImplemented(method) || - (!method.IsPrivate && !method.IsAssembly && !method.IsFamilyAndAssembly))) - set_visible = true; - - if ((set_visible == false) && (get_visible == false)) - return false; - else - return true; + { + MethodDefinition method; + bool get_visible = false; + bool set_visible = false; + + if ((method = property.GetMethod) != null && + (DocUtils.IsExplicitlyImplemented(method) || + (!method.IsPrivate && !method.IsAssembly && !method.IsFamilyAndAssembly))) + get_visible = true; + + if ((method = property.SetMethod) != null && + (DocUtils.IsExplicitlyImplemented(method) || + (!method.IsPrivate && !method.IsAssembly && !method.IsFamilyAndAssembly))) + set_visible = true; + + if ((set_visible == false) && (get_visible == false)) + return false; + else + return true; } private static bool ChkFieldVisible(FieldDefinition field) - { - TypeDefinition declType = (TypeDefinition)field.DeclaringType; - - if (declType.IsEnum && field.Name == "value__") - return false; // This member of enums aren't documented. - - return field.IsPublic || field.IsFamily || field.IsFamilyOrAssembly; - + { + TypeDefinition declType = (TypeDefinition)field.DeclaringType; + + if (declType.IsEnum && field.Name == "value__") + return false; // This member of enums aren't documented. + + return field.IsPublic || field.IsFamily || field.IsFamilyOrAssembly; + } - } - internal static class NBoolExtensions - { - public static bool IsTrue (this Nullable value) => - value.HasValue && value.Value; + } + internal static class NBoolExtensions + { + public static bool IsTrue (this Nullable value) => + value.HasValue && value.Value; } } diff --git a/mdoc/Test/AttachedEventsAndProperties/AttachedEventExample.cs b/mdoc/Test/AttachedEventsAndProperties/AttachedEventExample.cs index a2d0b3f98..77075bd18 100644 --- a/mdoc/Test/AttachedEventsAndProperties/AttachedEventExample.cs +++ b/mdoc/Test/AttachedEventsAndProperties/AttachedEventExample.cs @@ -17,7 +17,7 @@ public static void RemoveDragOverHandler(DependencyObject element, DragEventHand } #endregion - #region docs.microsoft.com example + #region learn.microsoft.com example public static readonly RoutedEvent NeedsCleaningEvent; public static void AddNeedsCleaningHandler(DependencyObject d, RoutedEventHandler handler) { diff --git a/mdoc/Test/AttachedEventsAndProperties/AttachedPropertyExample.cs b/mdoc/Test/AttachedEventsAndProperties/AttachedPropertyExample.cs index a6abd724c..ff039a994 100644 --- a/mdoc/Test/AttachedEventsAndProperties/AttachedPropertyExample.cs +++ b/mdoc/Test/AttachedEventsAndProperties/AttachedPropertyExample.cs @@ -5,7 +5,7 @@ namespace AttachedEventsAndProperties { public static class AttachedPropertyExample { - #region modified docs.microsoft.com example + #region modified learn.microsoft.com example public static readonly DependencyProperty IsBubbleSourceProperty = DependencyProperty.RegisterAttached( "IsBubbleSource", diff --git a/mdoc/mdoc.csproj b/mdoc/mdoc.csproj index 267427af0..f5a78616d 100644 --- a/mdoc/mdoc.csproj +++ b/mdoc/mdoc.csproj @@ -15,6 +15,8 @@ $(MSBuildThisFileDirectory)..\bin\$(Configuration)-$(TargetFramework) + win-x64 + false diff --git a/mdoc/mdoc.nuspec b/mdoc/mdoc.nuspec index 58ffbbfc9..c768c0d83 100644 --- a/mdoc/mdoc.nuspec +++ b/mdoc/mdoc.nuspec @@ -15,6 +15,6 @@ - + \ No newline at end of file