The Wayback Machine - https://web.archive.org/web/20201109185957/https://github.com/PrismLibrary/Prism/issues/1978
Skip to content

/ Prism

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Missing XML Docs #1978

Open
dansiegel opened this issue Dec 21, 2019 · 7 comments
Open

Add Missing XML Docs #1978

dansiegel opened this issue Dec 21, 2019 · 7 comments
Labels
Good First Issue WPF XF help wanted roadmap

Comments

@dansiegel
Copy link
Member

@dansiegel dansiegel commented Dec 21, 2019 •
edited

Summary

Many API's are currently lacking XML docs or have invalid markup. As we begin to explore adding API documentation to the Prism Docs, we need to update the existing codebase with more complete XML docs so that these docs can be generated for the docs site.

HACKTOBERFEST UPDATE

Thank you for joining us for your Hacktoberfest contributions... Please take some time to familiarize yourself with this issue. If you submit PR's for a single method in a single class please expect your PR to be closed as invalid

NOTE

While updated and added XML docs should include Summaries, and information for parameters/return values, it will often be better to ensure that remarks and examples are included as this will make the generated API docs more useful. Additional information on proper doc tags can be found here.

/// <summary>
/// The GetZero method.
/// </summary>
/// <example> 
/// This sample shows how to call the <see cref="GetZero"/> method.
/// <code>
/// class TestClass 
/// {
///     static int Main() 
///     {
///         return GetZero();
///     }
/// }
/// </code>
/// </example>
public static int GetZero()
{
    return 0;
}
@rssllgrrtt
Copy link
Contributor

@rssllgrrtt rssllgrrtt commented Feb 6, 2020

Hey.

I'm happy to chip in with this. Is there any particular area that you'd like to be covered first?
@dansiegel
Copy link
Member Author

@dansiegel dansiegel commented Feb 6, 2020

@rssllgrrtt if you build in Release you'll see a whole bunch of warnings with the following codes

CS1570
CS1572
CS1573
CS1574
CS1591

Just double click the warning and you should be taken to where the warning is and you can either fix bad blocks or add missing docs depending on what the code was for. You don't need to do everything and please don't try to do it all in a single PR.
@rssllgrrtt
Copy link
Contributor

@rssllgrrtt rssllgrrtt commented Feb 6, 2020 •
edited

@dansiegel OK, not a problem. I'll take a look at that in the next few days.

I won't be submitting loads of PR(s) anyway. I've been using Prism for years, but I'm new(ish) to GitHub and contributing. I'd be scared of submitting a big PR until I'm comfortable. I just figure it's time I started to give back :)

Thanks.
@dansiegel dansiegel added the roadmap label Mar 6, 2020
@d3fkn1ght d3fkn1ght mentioned this issue Apr 17, 2020
Merged
1 of 2 tasks complete
This was referenced Apr 18, 2020
Merged
Merged
@WaldemarCoding WaldemarCoding mentioned this issue Apr 21, 2020
Merged
2 of 3 tasks complete
@dansiegel
Copy link
Member Author

@dansiegel dansiegel commented Apr 22, 2020

Public Service Announcement... Before submitting a PR... or working on one... Be sure to leave a comment here for which classes/types you will be making changes for. This will help others from working on XML Docs for the same types/methods.
@WaldemarCoding
Copy link
Contributor

@WaldemarCoding WaldemarCoding commented Apr 24, 2020 •
edited

If nobody is already working on it, I would tackle the following files from Prism.Core next:

  • ModuleState.cs
  • IModuleCatalogItem.cs
  • TaskExtensions.cs
  • IModuleInfoGroup.cs
  • ModuleNotFoundException.cs
@d3fkn1ght
Copy link
Contributor

@d3fkn1ght d3fkn1ght commented Apr 28, 2020 •
edited

Submitted PR for documentation updates to the following files:
ApplicationStore.cs
EventToCommandBehavior.cs
IApplicationLifecycleAware.cs
IApplicationStore.cs
RuntimePlatform.cs

I skipped:
IAutoInitialize.cs as @dansiegel said he is working to remove it
@dansiegel dansiegel mentioned this issue Oct 2, 2020
Closed
@cabauman
Copy link
Contributor

@cabauman cabauman commented Oct 18, 2020

I'm currently working on:

  • IApplicationProvider
  • ApplicationProvider
  • IParameters
  • IDialogParameters
  • IDialogService
  • DialogService
  • IDialogServiceExtensions
@cabauman cabauman mentioned this issue Oct 18, 2020
Merged
2 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good First Issue WPF XF help wanted roadmap
Projects
None yet
Milestone
No milestone
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
5 participants
@dansiegel @d3fkn1ght @cabauman @WaldemarCoding @rssllgrrtt
You can’t perform that action at this time.