"Wayne Fay" <[EMAIL PROTECTED]> writes: > The "Documentation Check" (DOCCK) plugin was recently created to help > address this very issue. It will help not only Maven but also its > plugins and even other projects/plugins using Maven. >
Hello to all, And first great thanks to all maven developers and contributors for creating this really fascinating tool. I have been using maven 1.x and 2.z for about three now I think, in the beginning casually then on a regular basis for later projects (and when maven 2.0 was released). I have written plugins, filed one or two Jira issues, contributed to the best of my ability to MLs, started some discussions about maven reporting. I even use maven to generate my site and use custom skins (BTW, something painful given that you have to use such awful things as Velocity. My apologies to any Velocity team member lurking around there :-)), and tried writing a custom extension for doxia. I would be more than happy to contribute further but there are major issues I have been facing: 1. time is lacking to undertake the kind of things I would like to see in maven 2. development documentation is well below any standard Point 1 is beyond control, but other point deserve some explanations. As an example, take the class org.apache.maven.doxia.siterenderer.DefaultSiteRenderer. This class is responsible for the whole site generation process in doxia (and then maven) and there are about ten lines of comments in it (500 lines of code). Neither in the interface Renderer it implements. I am not particulary proud of my coding abilities and would certainly not rank among top level coders in any contest, but I know two things for sure about software engineering: write comments where they are useful, write thorough unit tests to further document and assert the quality of your the code (and your understanding of th erequirements). This have hurt me when I tried to extend Doxia with a new module. I am not of course pointing at anyone in particular, as this state of affair is really common in all maven code fragments I have seen. But when you add poor code documentation to no user documentation... Last but not least, I follow Jeff Muntunho in his rant when he says that support from developers is rather scarce. I know that open source is a harsh mistress and I am sure this is not a willingful attitude, but it is sometimes discouraging not to have answers from those who know. my 50 cents, -- Arnaud Bailly, PhD. OQube < software engineering \ génie logiciel > \web> http://www.oqube.com --------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
