Hello Daniel, Yep, as you have seen the documentation is generated from the XML comments in the rules source code. Historically it made it much easier to enforce that documentation was available (and up to date) for all rules. Recently (even if that was a much older goal ;-) it also allowed to get separate documentation trees for each (new) version of Gendarme. Users can now read the documentation that match the version of Gendarme they are using (including new rules only available in git/ master).
Sadly the tools (mostly xmldoc2wiki, which is available in git) are a long way from being perfect. Sometimes the XML looks fine while the the generated documentation looks bad. This is mostly because XML does not keep the actual formatting (like spaces/tabs) so this must be re- generated by the tools. However it is easy to fix them (in sources / pull request) and even not too hard to set up / test locally (w/gollum). In any case reporting the issue here is perfectly correct (as stated in the documentation page footer). Thanks for reporting the issue! Sebastien p.s. I had a file system crash last week and, while I did not lose anything (well almost), I'm still a bit affected by this (mostly the time to set up again my laptop). But don't worry I'll fix this issue (and others) soon :-) On Mar 14, 11:15 am, Daniel Lidström <[email protected]> wrote: > Hello, > > the Good sample for rule DoNotUseLockedRegionOutsideMethodRule is > wrongly indented. It looks as if a method is inside another method. > I've changed the 2.10 github wikipage, but that was before I realized > it was a generated page. > > Regards, > > Daniel -- You received this message because you are subscribed to the Google Groups "Gendarme" group. To post to this group, send email to [email protected]. To unsubscribe from this group, send email to [email protected]. For more options, visit this group at http://groups.google.com/group/gendarme?hl=en.
