XML documentation files

This forum is only for questions or discussions about working with the mojoPortal source code in Visual Studio, obtaining the source code from the repository, developing custom features, etc. If your question is not along these lines this is not the right forum. Please try to post your question in the appropriate forum.

Please do not post questions about design, CSS, or skinning here. Use the Help With Skins Forum for those questions.

This forum is for discussing mojoPortal development

This forum is only for questions or discussions about working with the mojoPortal source code in Visual Studio, obtaining the source code from the repository, developing custom features, etc. If your question is not along these lines this is not the right forum. Please try to post your question in the appropriate forum.

You can monitor commits to the repository from this page. We also recommend developers to subscribe to email notifications in the developer forum as occasionally important things are announced.

Before posting questions here you might want to review the developer documentation.

Do not post questions about design, CSS, or skinning here. Use the Help With Skins Forum for those questions.
This thread is closed to new posts. You must sign in to post in the forums.
4/28/2014 5:40:07 PM
Jamie E
Gravatar
Total Posts 1203
View Posts
Proud member of the mojoPortal team

Help support mojoPortal!
Add-on modules

XML documentation files

Hi Joe, I was looking into trying to reduce the number of warnings generated during full recompiles of the mojo source. A number of the assemblies have the XML documentation file option turned on in the build properties, but are missing member comments, leading to hundreds of these type of warnings:

warning CS1591: Missing XML comment for publicly visible type or member 'mojoPortal.Business.WebHelpers.PaymentGateway.PaymentGatewayResponse'

These make it hard to find "legitimate" warnings that I might care about. Is it safe to turn off the XML documentation file option for the source controlled assemblies? Does this option serve any purpose in the big scheme of things, or is it possibly outdated?

Thanks,

Jamie

4/30/2014 12:02:30 PM
Joe Audette
Gravatar
Total Posts 18439
View Posts

Re: XML documentation files

Those xml comment warnings have now been suppressed in the latest code in the source code repository.

Best,

Joe

4/30/2014 12:41:28 PM
Jamie E
Gravatar
Total Posts 1203
View Posts
Proud member of the mojoPortal team

Help support mojoPortal!
Add-on modules

Re: XML documentation files

Great, thanks Joe!

Jamie

4/30/2014 2:05:03 PM
Jamie E
Gravatar
Total Posts 1203
View Posts
Proud member of the mojoPortal team

Help support mojoPortal!
Add-on modules

Re: XML documentation files

Hey Joe, I was still getting the warnings, so I took a look at what was happening. Unfortunately the .csproj files have a separate build section for each configuration/platform combination, so the suppression was only happening for the main MSSQL Release/Debug configs. I tested this by copying

    <NoWarn>1591</NoWarn>

from the MSSQL to the MySQL sections in mojoPortal.Web.Framework.csproj using a text editor, and that worked.

Jamie

4/30/2014 2:22:51 PM
Joe Audette
Gravatar
Total Posts 18439
View Posts

Re: XML documentation files

should be fixed now, I've gone through all the release build profiles and suppressed that warning, previously I had only done it under Release which is the mssql release profile.

Thanks,

Joe

You must sign in to post in the forums. This thread is closed to new posts.