This sounds like a good plan to me. My first problem is to build the files myself! Again, being a previous Windows user I haven't used doxygen before and I am not set up to run the configure files. So... I have installed doxygen (and graphViz) and am trying to run for the first time with a bit of 'guess the settings'. If I get anything half-decent I will then have a little play with setting up the website here on bitbucket. I will let you know how I get on.
I have discovered that this process has already been initiated! Try going to "http://coin3d.bitbucket.org/" in your browser. There is a single web page, albeit out of date. I do have access to this repository so I can get it up to date.
Oh, good. It seems the text there is the same as on the wiki, accessible by clicking the "IntroductionToCoin3D" link on www.coin3d.org. Not sure if it is wise to have it that way, they will get out of sync sooner or later.
Are you planning to host API documentation for the different Coin modules in subdirectories as described here?
I haven't actually changed anything yet! In the first instance I am looking at the source files in the repository that generate the 'Main Page' as a starter. When I get it sorted I will generate the HTML index page and substitute it for the old one.
Yes, I was thinking of using subdirectories as described in the Atlassian documentation.
Thanks for the offer of help. I might well take you up on it. Once I get all the processes established.
I have now completed the first stage of the Coin documentation update. It is now accessible at http://coin3d.bitbucket.org/Coin. I have added most of the original images (33 out of 38) and updated the layout.
Please give me some feedback. What is wrong with it? What will make it better, etc?
I know that there is still a lot of undocumented stuff. That is all in stage 2 to follow. I will then update the source code in the Coin repository so you can make your own.
I am committing my source code changes so far to enable all users to generate their own documentation to match the current online documentation repository. Note that this may be buggy - I am still as yet unable to fully test it.
When running doxygen (version 1.8.8) I still get a whole host of warning messages about undocumented things. I will gradually work through them and update the repositories occasionally.
I have noted that searching google for any of the coin classes does now have our documentation included in the results, albeit they may be some way down. Hopefully they will rise towards the top as they are used more.
As doxygen has developed two of the tags used within the coin.doxygen.in file have been obsoleted. These are SHOW_DIRECTORIES and HTML_ALIGN_MEMBERS. This occurred from version 1.8.1 released 19/05/2012. I will references to these, unless there are any objections.
OK. So I have now made major changes to the primary doxgen input file for Coin. Notwithstanding any howlers on my part this should now allow anyone to build the documentation to be identical to that online using the configure command shown by Christian in the first comment above.
Having the documentation online again is really great and I use it quite often now. Working a bit on the class documentation I also downloaded doxygen and played a bit with the settings. Newer versions also support a tree view as an alternative to the top bar navigation. I noticed that with the current online references (using the top navigation bar) I have to navigate back and forth very often. In my opinion this becomes much better with the navigation tree on the left. Also I really like the hierarchical structure, especially under modules. Here is a screenshot:
But this seems to be a matter of personal taste too. So I wanted to ask how others feel. Please comment!
BTW: In order for this to work a few more files have to be updated (header, footer, some dox files). Of course I can provide those if we decide to go this way.
Roy, I am not sure I am looking at the right files. I only see coin/docs/coin.doxygen.in together with coin_doxygenfiles.inc. Are these the ones that are in use right now? I ask because I was reading the part about adding nodes in coin/docs/HACKING.