Add Missing XML Docs

[dansiegel]

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;
}

[ghost]

Hey.

I'm happy to chip in with this. Is there any particular area that you'd like to be covered first?

[dansiegel]

@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.

[ghost]

@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]

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]

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]

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

[cabauman]

I'm currently working on:

• IApplicationProvider
• ApplicationProvider
• IParameters
• IDialogParameters
• IDialogService
• DialogService
• IDialogServiceExtensions

[Adam--]

Figured I'd help out and write some documentation for navigation in Prism.Forms. Learned a little bit while doing it too.

[niimima]

I never contribute OSS, but I try this issue. I will work below item as first step.

• IModuleGroupsCatalog

[brianlagunas]

@niimima every little bit helps

[niimima]

I will work below items.

• IDialogResult
• DialogResult