I'm working on a C++ and Objective C iPhone Project. I'm using git as my version control system.
The codebase has been growing quite a bit, so I would like to add Doxygen to the project. The problem is that I'm not sure about what would be the best approach to do it.
I've thought about a couple of options:
1) Create the Doxygen HTML documentation in the project folder and make it "part" of the project so that it is also versioned and committed to git.
2) Create the Doxygen HTML documentation in the project folder and add it to the .gitignore
so each user of the project is responsible for generating the docs and the project git repository would remain untouched (except for the .gitignore
).
We are using a git --bare repository in our main server, so to mount a webpage containing the HTML Doxygen in the server would be complicated ( you can't actually see the project files with a git --bare repo, so I won't be able to see the Doxygen generated HTML doc unless I uploaded it separately )
Maybe I could make some kind of cron-job
, to keep the doxygen updated on the server side ?
Help is very welcome.