XML Documentation xsd and samples how it could look like#2
XML Documentation xsd and samples how it could look like#2edorian wants to merge 3 commits intosquizlabs:masterfrom edorian:master
Conversation
…inst / work with to easy the writing of the xml
There was a problem hiding this comment.
This should be: Checks all lines in the file and shows warnings or errors if they are too long
|
Besides the above text changes, I really like where this is going. If we can agree on the wording, we're good to go. Although I still need to write some code to substitue those keywords with their correct values based on the standard the user selected. |
|
I'm sorry about the bad wordings. I didn't proofread this even so i really should have :) If you want to note the ability to change those values on every sniff that has changeable configuration I'm fine with that. I'm aware of the abilty to change the values in the ruleset file.. i didn't think about extending the sniff classes to be honest as the xml file is all I ever used :) Let me know if you find other issues or pull and I'll get started on writing something for every sniff in generic |
There was a problem hiding this comment.
Thinking more about it, this isn't gong to work. If you have disabled your absoluteLineLimit (set it to zero) then the message will show:
"It is recommended to keep lines at approximately 80 characters long for better code readability and lines should never exceed 0 characters."
We obviously need to devise a smarter system that allows documentation to be generated based on the values that the project-specific standard is setting.
|
I think this is more complex than a pull request is going to achieve. I think we need to start again on this and plan it out properly. It requires changes to the existing documentation generator code as well as changes to the documentation itself. I also wont be pulling this in if it stops existing documentation from being generated, which it obviously will due to the need to make core changes that have not yet been done. If you'd like to start creating examples and basic documentation for the existing sniffs using the existing XML format, I'd be very happy to accept those contributions. But I'll need to have a bit more of a think about how best create customised standard documentation. |
|
Anyways, thanks for getting back to me on this :) |
Relax class name req's; we're not yet namespacing
…h and open files in that during interactive session
…h and open files in that during interactive session
…is incorrectly quoted
…h and open files in that during interactive session
…is incorrectly quoted
…h and open files in that during interactive session
…is incorrectly quoted
…h and open files in that during interactive session
…is incorrectly quoted
…h and open files in that during interactive session
Continuing the discussion I had with @gsherwood in #1
I needed recreate the PR because github refused to update the range.