dotnet-api-docs icon indicating copy to clipboard operation
dotnet-api-docs copied to clipboard

Document BreakForUserUnhandledException and DebuggerDisableUserUnhadledExceptionsAttribute

Open tommcdon opened this issue 1 year ago • 8 comments

Summary

Documents the following missing items added during .NET 9

Summary Parameters TypeParameters ReturnValue API
Missing Missing NA NA M:System.Diagnostics.Debugger.BreakForUserUnhandledException(System.Exception)
Missing NA NA NA M:System.Diagnostics.DebuggerDisableUserUnhandledExceptionsAttribute.#ctor
Missing NA NA NA T:System.Diagnostics.DebuggerDisableUserUnhandledExceptionsAttribute

Fixes https://github.com/dotnet/runtime/issues/105980

tommcdon avatar Sep 18 '24 05:09 tommcdon

Tagging subscribers to this area: @tommcdon

@gewarren @carlossanlop

tommcdon avatar Sep 18 '24 05:09 tommcdon

Learn Build status updates of commit 648c9aa:

:warning: Validation status: warnings

File Status Preview URL Details
xml/System.Diagnostics/Debugger.xml :warning:Warning View Details
xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml :warning:Warning View Details

xml/System.Diagnostics/Debugger.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Diagnostics.DebuggerDisableUserUnhandledExceptions'.
  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'paramref' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'System.Diagnostics.Debugger.BreakForUserUnhandledException'.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Learn Build status updates of commit 64b265e:

:white_check_mark: Validation status: passed

File Status Preview URL Details
xml/System.Diagnostics/Debugger.xml :white_check_mark:Succeeded View
xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml :white_check_mark:Succeeded View

For more details, please refer to the build report.

For any questions, please:

Learn Build status updates of commit 4fe7e0c:

:white_check_mark: Validation status: passed

File Status Preview URL Details
xml/System.Diagnostics/Debugger.xml :white_check_mark:Succeeded View
xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml :white_check_mark:Succeeded View

For more details, please refer to the build report.

For any questions, please:

Learn Build status updates of commit 97436ed:

:x: Validation status: errors

Please follow instructions here which may help to resolve issue.

File Status Preview URL Details
:x:Error Details
xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml :x:Error Details

  • Line 0, Column 0: [Error: ECMA2Yaml_File_LoadFailed] Failed to load 1 files, aborting...

xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml

  • Line 0, Column 0: [Error: ECMA2Yaml_InternalError]
Intenal Several Error: System.Xml.XmlException: The 'summary' start tag on line 23 position 6 does not match the end tag of 'para'. Line 24, position 384.
   at System.Xml.XmlTextReaderImpl.Throw(Exception e)
   at System.Xml.XmlTextReaderImpl.Throw(String res, String[] args)
   at System.Xml.XmlTextReaderImpl.ThrowTagMismatch(NodeData startTag)
   at System.Xml.XmlTextReaderImpl.ParseEndElement()
   at System.Xml.XmlTextReaderImpl.ParseElementContent()
   at System.Xml.Linq.XContainer.ReadContentFrom(XmlReader r)
   at System.Xml.Linq.XDocument.Load(XmlReader reader, LoadOptions options)
   at System.Xml.Linq.XDocument.Parse(String text, LoadOptions options)
   at ECMA2Yaml.ECMALoader.LoadType(FileItem typeFile)
   at ECMA2Yaml.ECMALoader.LoadTypes(String basePath, Namespace ns)

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Learn Build status updates of commit 66866d2:

:warning: Validation status: warnings

File Status Preview URL Details
xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml :warning:Warning View Details
xml/System.Diagnostics/Debugger.xml :white_check_mark:Succeeded View

xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml

  • Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gewarren I believe all feedback has been addressed. There is a new warning caused by the <see> tag in the summary section of the docs, but I see other <see> directives in other sections, so not sure what it is getting flagged. The preview notes look correct to me.

tommcdon avatar Sep 20 '24 17:09 tommcdon

@gewarren sorry for the additional ping, please let me know if there is any additional feedback on this PR

tommcdon avatar Sep 23 '24 14:09 tommcdon

Learn Build status updates of commit ad90489:

:white_check_mark: Validation status: passed

File Status Preview URL Details
xml/System.Diagnostics/Debugger.xml :white_check_mark:Succeeded View
xml/System.Diagnostics/DebuggerDisableUserUnhandledExceptionsAttribute.xml :white_check_mark:Succeeded View

For more details, please refer to the build report.

For any questions, please: