Skip to content
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

Generate full Xml documentation #164

Open
rammi987 opened this issue Feb 12, 2018 · 8 comments · May be fixed by #225
Open

Generate full Xml documentation #164

rammi987 opened this issue Feb 12, 2018 · 8 comments · May be fixed by #225
Labels
state/backlog Backlog, To Do type/feature Feature

Comments

@rammi987
Copy link

rammi987 commented Feb 12, 2018

note: title was "Modelsbuilder does so projekt not can build on special settings" and the idea is to generate the full /// Xml documentation so that building models does not trigger warnings.

Hello,

I work on a project where in the main project where Umbraco living, under the VS project properties inside Build is under output XML documentation file set to true,
witch only will give an warning but we tread all warnings as errors
"errors and warnings" "warning level: 4"

Trouble is Modelsbuilder not write xml

on the deffined public class, or not set a warning disable #number.

This gives some troubles there cuorse project no to build;
i have try to set model builder to go out to an other code lib, where theise settings not is on,
but the new problems is it requried Umbraco install and lots of other dll include before it will work, so thats a huge opreations for something simple.

can you help here?

@ksuvec
Copy link

ksuvec commented Feb 13, 2018

Hi rammi987.

We at Umbraco are not sure we quite understand your issue, we would however like to help you sort it out :) If you can write me an e-mail on [email protected] explaining your problem in danish, I will make sure we take a good look at it.
Regards,
Kristian

@zpqrtbnk
Copy link
Collaborator

Is it... that MB generates code that is not completely and properly documented with /// xml comments, which causes warnings during compilation, and warnings are treated as errors, which breaks your build?

Any chance you can post a list of those warnings here? We can fix MB by either generating the proper comments or by disabling these warnings in the MB generated code.

@rammi987
Copy link
Author

@ksuvec as @zpqrtbnk is telling, i attach an image where you can see the warnings, and on witch line.
And a image of the webappliation propertie page with the settings.

image
image

@zpqrtbnk
Copy link
Collaborator

got it - thinking now

@rammi987
Copy link
Author

Easy is just disable cs1591

Meaby best solutions is, the Code analysis suppress results from generated code like edmx generate classes can. (edmx does´t have xml comments, but skip the warnings)

Or custom able from web.config what warnings should be disable

@zpqrtbnk zpqrtbnk changed the title Modelsbuilder does so projekt not can build on special settings Generate full Xml documentation Jun 18, 2019
@zpqrtbnk zpqrtbnk added state/backlog Backlog, To Do type/feature Feature labels Jun 18, 2019
@michaelchart
Copy link

@zpqrtbnk We also have this issue. Could we add in something for now that disables the warnings?

If we were to contribute a PR to this effect, should we do so in the UmbracoCms repo, or this one?

@zpqrtbnk
Copy link
Collaborator

are you using the MB version that adds the "generated" attribute? that attribute supposedly helps suppressing warnings... other than that, a PR is fine - on this repository yes.

@michaelchart
Copy link

@zpqrtbnk Yes, the generated attributes are present

image

I'll take a look at creating a PR, either to add some XML comments or disable the warnings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state/backlog Backlog, To Do type/feature Feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants