Greetings to all!
I've just finished building the code documentation for OpenFOAM 1.7.1 in Debian Lenny (the stable one). I haven't tried Squeeze (the testing one) because I've been a bit confused on how Debian is installed :( Anyway, the documentation built successfully without any errors. And I owe an apology to Nicolas: I didn't know that OpenFOAM's code documentation now uses php instead of html :( I also had to setup apache2+php5 as well, to get things going. I also found out that the javascript that exists in the online version isn't present in locally built version... but the search box still works as a normal form! But this could be because of the Doxygen version that comes with Debian Lenny. So, Nicolas, I can only assume that the Squeeze/testing version you are using of Debian still has a few bugs in it and those might have hit either Doxygen or some other application it depends on. Or the file system was unable to fully handle the over 46000 files that are created inside the html folder! I'll try to upgrade to Squeeze and build the documentation again. Perhaps I can trip the same problem that Nicolas had. Best regards, Bruno |
It is possible in Doxygen to change the php extension to html in the Dixyfile I manage to get the sherch to work with only php. adding the option:
SERVER_BASED_SEARCH = YES (Make saerch work but only with php) at the end ove the Doxyfile I alsow change SHORT_NAMES = YES (Your suggestion, seams to make a difference ) DOT_CLEANUP = NO (to get ride of the first error I got) and put back the value of DOT_GRAPH_MAX_NODES and MAX_DOT_GRAPH_DEPTH as it was in the OpenFOAM1.6 version But the Java search is nice on the website and don't work on locale !! If you find how to make it work I'll be happy ! :) Thanks for the help |
1 Attachment(s)
Hi Nicolas,
OK, attached is a compressed file hackHtml.gz with a shell script that will finish what Doxygen started. Download it and unpack it in the folder "$WM_PROJECT_DIR/doc/Doxygen". Then run: Code:
chmod +x hackHtml The next time you open/refresh the index.html or index.php browser page (depending on those options you posted about), you should have that neat-o search box up and running :D Notes:
Best regards, Bruno |
Thanks for the Bruno. Im using Ubuntu 10.04, OpenFOAM 1.7.1 etc..... Worked like a charm.
|
Hi,
I have the same problem as Nicolas had. While trying to compile the documentation for 1.7.x on debian squeeze I get an error: Quote:
best regards, Ilya |
Hi Ilya,
I had the same problem a few days ago with OpenFOAM 2.0 in my Ubuntu 11.10 (Doxygen 1.7.3, if I'm not mistaken), so I had to go back to using Doxygen 1.6.3. It seems that Doxygen versions >= 1.7.0 have serious problems with OpenFOAM's code :( In Ubuntu, I sort of used these instructions of mine: http://www.cfd-online.com/Forums/ope...tml#post317304 post #4. But instead of using Natty, I used Lucid's repositories. I'm not sure how you can do this in Debian :( but it should be similar, since Ubuntu is based on Debian. Best regards, Bruno |
Thanks Bruno,
with an older version of doxygen doc was compiled successfully. But it still doesn't work properly. Class diagrams don't show any other classes besides of the chosen one and search bar starts an endless loop trying to open search.php Do I need something else to open php-files, or do I still have problems with doxygen? Best regards, Ilya http://s11.postimage.org/8gbpmn05d/doxygen.jpg |
Hi Ilya,
OK, I was wondering about some issues I had with Doxygen 1.6.3 (took several hours to build the code documentation on Ubuntu 11.10, while in 10.04 it took only about an hour), so I rolled up my sleeves and did the following:
____________________________________ edit: OK, steps 5 and 6 only get you a half-baked version of the code documentation :( To get a better version of the code documentation, I did the following steps, to replace steps 5 and onward:
Best regards, Bruno |
Hi Bruno,
first, thank you very much: the compilation went fine, I the doc works like it should work. The only issue I still have is refers to the search box. The browser still tries to open search.php, which it can't open. Supposable it isn't a problem of doc generation and there is something else missing on my system. Do you have any ideas? Best regards, Ilya |
Illya, I think you need a http server with a PHP interpreter for the host to work.
|
Hi Ilya and Anton,
Quote:
Quote:
Best regards, Bruno |
Right! That's what I get for jumping into the middle of a discussion I haven't been actively following :o
Quote:
|
Quote:
yes, I followed only the second part of your post, but not the first one. So I didn't build the doc under 2.0.x, but I deleted the Doxygen folder in 1.7.x and replaced it with the one from 2.0.0 and built it. I didn't clean the previous build with ./Allwclean, but since I deleted the entire folder I thought there is nothing left. And SERVER_BASED_SEARCH is set to NO in Doxyfile, that's right. Best regards, Ilya |
Hi Ilya,
This is very odd. I retried it once again with a clean Doxygen folder on "OpenFOAM-1.7.x/doc", made from a clean copy from "OpenFOAM-2.0.x/doc/Doxygen" (no html folder nor other files generated by Doxygen). It worked as intended! The only details that come to mind that you might have missed are:
Best regards and good luck! Bruno |
Hi Bruno,
i used doxygen 1.5.6 and yes I tried to refresh the page or to open it in an other browser to prevent the use of any cashed elements. Best regards, Ilya |
Hi Ilya,
Ah, then that's the problem! You've got to use the latest Doxygen version, because the files copied from OpenFOAM 2.0.x were designed to use Doxygen 1.7.0 and above! I should have pasted here the instructions for installing 1.7.5.1, but I'll do the same as before ;) - Read the part from this blog post of mine «Building Code Documentation on OpenFOAM 2.0.0/x» that talks about manually installing Doxygen 1.7.5.1 on your home folder. The instructions are for an architecture of x86_64, but if you got i686, I think the Doxygen site has info on how to compile it. Then it should work as intended! @Anton: it's possible that the Doxygen bug on OpenFOAM 1.7.x was related to a limitation on Doxygen itself, therefore always requiring PHP. Best regards, Bruno |
Hi Bruno,
thanks a lot again. With doxygen 1.7.5.1 everything works fine. Best regards, Ilya |
When I followed the procedure from post #28, I only got the Main Page, Related Pages, Files and Directories tabs. I used the OF-2.0.0 doxygen config files, the source of OF-1.7.1 and doxygen 1.7.6.1.
I got a complete and working documentation only with these options in the doxyfile: INPUT_FILTER = doxyFilt FILTER_SOURCE_FILES = YES SHORT_NAMES = NO Regards, Buffi |
Greetings Buffi,
I'm having trouble fully understanding this statement: Quote:
Best regards, Bruno |
It is 2: I needed to modify those options in the Doxyfile from OF-2.0.0. Thanks for pointing out!
|
All times are GMT -4. The time now is 21:28. |