ATR-759: Add release notes for 3.1.2, update 1007 diagnostic description #496
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
SENya1990
reviewed
May 29, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
reviewed
May 30, 2023
SENya1990
requested changes
May 30, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
SENya1990
reviewed
Jun 5, 2023
| - Adds the `summary` XML tags, in which you type the description of the code item | ||
| - Adds the `exclude` XML tag, which excludes the item from the API and DAC References | ||
| - Adds the `inheritdoc` tag to a mapped DAC property of a projection DAC. | ||
| To apply the code fix and add the `inheritdoc` tag to multiple DACs, you can use the **Fix All** button in the code fix menu of Visual Studio. Clicking this button will automatically generate correct documentation for most of the projection DAC properties. | ||
| This code fix also deletes incorrect documentation tags like `summary` or other incorrectly declared `inheritdoc` tags that should not be placed on the mapped property of a projection DAC. | ||
|
|
||
| The new diagnostic is available only if the value of **Tools > Options > Acuminator > Code Analysis > Enable PX1007 diagnostic** is _True_. By default, the value of this option is _False_. |
There was a problem hiding this comment.
Maybe we should extend the guide to enable the diagnostic with info from this article but I'm not insisting:
https://wiki.acumatica.com/display/TND/Enabling+PX1007+in+Visual+Studio
SENya1990
reviewed
Jun 5, 2023
| @@ -28,14 +36,13 @@ The diagnostic is currently displayed for the following public entities: | |||
| - DAC property fields | |||
|
|
|||
| The diagnostic is not displayed for the following items: | |||
| - Entities with the `PXHidden`, `PXInternalUseOnly`, or `Obsolete` attribute. | |||
| - Entities with the `PXInternalUseOnly` or `Obsolete` attribute. | |||
| ** Note: ** The `PXHidden` attribute does not suppress the diagnostic. | |||
There was a problem hiding this comment.
This is not correct. PXHidden attribute suppresses the XP1007 diagnostic but only for DACs. This attribute is applied only to DACs in general. It shouldn't be used on DAC extensions or DAC properties. The changes in this release ensured that the declaration of PXHidden on something other than DAC will have no effect.
SENya1990
reviewed
Jun 5, 2023
| @@ -28,14 +36,13 @@ The diagnostic is currently displayed for the following public entities: | |||
| - DAC property fields | |||
|
|
|||
| The diagnostic is not displayed for the following items: | |||
| - Entities with the `PXHidden`, `PXInternalUseOnly`, or `Obsolete` attribute. | |||
| - Entities with the `PXInternalUseOnly` or `Obsolete` attribute. | |||
| ** Note: ** The `PXHidden` attribute does not suppress the diagnostic. | |||
| - Members of public entities (except nested public types and DAC property fields). | |||
| - All members of a public entity if the entity has the `exclude` XML tag or is marked with the `PXHidden`, `PXInternalUseOnly`, or `Obsolete` attribute. | |||
There was a problem hiding this comment.
The part with attributes is not precise and became outdated. It should be updated with something like this:
- All members of a public entity if the entity has the `exclude` XML tag or is marked with the `PXInternalUseOnly`, or `Obsolete` attribute. You can also exclude DACs from the documentation by marking them with `PXHidden` attribute.
SENya1990
reviewed
Jun 5, 2023
SENya1990
requested changes
Jun 5, 2023
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
SENya1990
approved these changes
Jun 6, 2023
Co-authored-by: Sergey Nikomarov <snikomarov@acumatica.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.