On Sun, Feb 13, 2011 at 10:49 PM, Fabien Potencier <[email protected]> wrote: >> But more importantly I think these classes are a perfect opportunity to >> ease documentation. My idea is that there should be some tool to generate >> human readable documentation out of these Configuration classes in the reST >> format. This documentation would list the defaults and the merging rules. >> Potentially even generate some examples (though maybe for that we might need >> to ponder if we need to add some comment standard for the Configuration >> classes) in different formats.
Yup, I was also thinking about this, that every *Node() method should have a second parameter that is "docs", where you can put some description about what the node is. Now even if we don't do anything with it, it'll still be available in the code, which should be helpful. I also suggested that to Bernhard last week for Form options, that every addOption() should have a description param, where you can explain a bit more. And that would be used in exceptions for mandatory options that are missing, because some are a bit ambiguous if you just look at the name. Cheers -- Jordi Boggiano @seldaek :: http://seld.be/ -- If you want to report a vulnerability issue on symfony, please send it to security at symfony-project.com You received this message because you are subscribed to the Google Groups "symfony developers" 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/symfony-devs?hl=en
