#419 Generate Coding Standards Documentation

Future
closed
nobody
5
2016-02-28
2006-03-10
No

Wouldn't it be fabulous if you could take a
checkstyle.xml, run it through a tool and generate a
text description of the checks being produced as input
to a coding standards document?

Discussion

  • G.Ryan

    G.Ryan - 2006-09-12

    Logged In: YES
    user_id=1596723

    I too would be interested in this feature, even if it merely
    generates a modified version of the API documentation for
    each of the enabled checks, it would still provide a
    reasonable human-readable reference.

     
  • Dave Copeland

    Dave Copeland - 2008-09-08

    I think this would be pretty easy to implement if the API documentation has a separate page for each check (as opposed to one page per grouping). You could then just create URLs based on what you find in checkstyle.xml.

     
  • Roman Ivanov

    Roman Ivanov - 2016-02-28
    • status: open --> closed
    • Group: --> Future
     
  • Roman Ivanov

    Roman Ivanov - 2016-02-28

    that is lamost impossible to do, to generate docuemnt that is readable by human.

    Nobody read code standards, that is utopia.

     

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks