Version control – advantages and disadvantages of version control Javadoc
I'd like to know whether to submit Javadoc files to my project's SVN repository
I've read about SVN good practices, including some interesting questions about so, but none is specifically for Javadoc
At first, I agreed that only the source code should be versioned, and I thought using eclipse or from Javadoc Rebuilding Javadoc from an XML ant file is very easy, but I also think of these points:
>Javadoc files are light, text encoded, and you can easily track changes to these files using the diff tool. > It seems interesting to easily track changes to Javadoc, because in the case of "public" Javadoc, any changes to it may mean changes to the API. > People who are willing to view Javadoc don't necessarily want to get the whole project and compile it, so putting it into repo seems to be another good idea to allow effective sharing / tracking
What do you think of this? Please answer with a constructive, non - subjective argument I'm interested to know which case scenarios encourage Javadoc versioning, which makes it look like a bad choice
Solution
One argument against is merge conflict. As a former SVN user, I hate merging with SVN Even with git, if these problems occur, this is just another working step If you are in a larger team, merging regularly is a daily job
Another objection is that if some people don't want the whole source code tree, put the whole project under a CI system such as Hudson and regularly trigger the creation of Javadoc, such as submitting and publishing them somewhere
For me, conclusio is: no version of JavaDocs