Bug 58856 - Boilerplate for [SomeEnum]Extensions classes.
Summary: Boilerplate for [SomeEnum]Extensions classes.
Status: ASSIGNED
Alias: None
Product: iOS
Classification: Xamarin
Component: Tools (show other bugs)
Version: XI 10.99 (xcode9)
Hardware: All All
: --- enhancement
Target Milestone: Future Cycle (TBD)
Assignee: Manuel de la Peña [MSFT]
URL:
Depends on:
Blocks:
 
Reported: 2017-08-17 17:43 UTC by Mike Norman
Modified: 2018-05-22 11:16 UTC (History)
2 users (show)

Tags:
Is this bug a regression?: ---
Last known good build:

Notice (2018-05-24): bugzilla.xamarin.com is now in read-only mode.

Please join us on Visual Studio Developer Community and in the Xamarin and Mono organizations on GitHub to continue tracking issues. Bugzilla will remain available for reference in read-only mode. We will continue to work on open Bugzilla bugs, copy them to the new locations as needed for follow-up, and add the new items under Related Links.

Our sincere thanks to everyone who has contributed on this bug tracker over the years. Thanks also for your understanding as we make these adjustments and improvements for the future.


Please create a new report for Bug 58856 on Developer Community or GitHub if you have new information to add and do not yet see a matching new report.

If the latest results still closely match this report, you can use the original description:

  • Export the original title and description: Developer Community HTML or GitHub Markdown
  • Copy the title and description into the new report. Adjust them to be up-to-date if needed.
  • Add your new information.

In special cases on GitHub you might also want the comments: GitHub Markdown with public comments

Related Links:
Status:
ASSIGNED

Description Mike Norman 2017-08-17 17:43:38 UTC
The `[SomeEnumeration]Extensions` classes that have `GetValue` and `GetConstant` are ripe for automation. A quick grep for "<summary>" in the relevant sources (-name "*Extensions.xml") would reveal the text we've been using, and the variations could be ironed out into some reasonable, writer-approved, boilerplate.
Comment 1 Sebastien Pouliot 2017-08-18 01:50:54 UTC
@Mike can you provide us with the generic _ writer-approved_ text that should be generated ? thanks!
Comment 2 Sebastien Pouliot 2018-04-04 15:16:55 UTC
ping
Comment 3 Mike Norman 2018-04-04 20:49:23 UTC
The following:
<summary>Returns the string constant for the enumeration value.</summary>

for GetConstant, and:
<param name="constant">The string for which to return an enumeration value.</param>
<summary>Returns the enumeration value for the provided string.</summary>

for GetValue.

Note that our current text differs, but that the above text is more correct. We, the docs team, can change the existing text.
Comment 4 Sebastien Pouliot 2018-05-08 13:21:14 UTC
thanks!
Comment 5 Manuel de la Peña [MSFT] 2018-05-22 11:16:14 UTC
@sebastien, should we move this issues to maccore?