[OpendTect_Developers] Doxygen documentation of current (4.4.0c) OpendTect version

[Raman Singh]

Dear fellow developers,

As Omer rightly pointed out, there was indeed a wrong link in the Class 
documentation package of 4.4.0 which we have corrected now. Thanks Omer 
for bringing it up!

So, the link on the website is working again and if you want to use the 
documentation offline you can get the updated one (version 4.4.0c1 of 
Developers' Documentation) using the Installer.

Now, to answer Omer's questions about missing subfolders, that was the 
structure upto OpendTect 4.2.0 or rather 4.3.0. Now in the new directory 
structure, there is only one index file 
(doc/Programmer/Generated/html/index.html) which should take care of all 
other links. Since you have mentioned that your 
doc/Programmer/Generated/html directory seems to contain all the 
documentation files, you seem to have the right stuff. Now that the 
online things are working, you would probably like to use that. Should 
you need the offline version, I would suggest an update of the 
Developers' Documentation package using the installer and you will have 
the correct link in doc/Programmer/index.html.

If you still face problems, please get back to me.

Best regards,
Raman


On 10/25/2012 04:31 PM, oemergenc at gmail.com wrote:
> Hey there,
>
> is there a way to get a complete and up-to-date documentation of the 
> current OpendTect release generated by doxygen?
> The online resource contains some missing links, especially for the 
> most important "main pages":
>
> http://www1.opendtect.org/rel/doc/Programmer/Generated/index.html
>
> When clicking on "main page" of a module the link is broken.
>
> However i tried building one on my own. When running the installer i 
> checked the checkboxes for the following items:
>
> - User Documentation
> - Documentation for the dGB Plugins
> - Developers' Documentation
>
> After the installation finishes the OpendTect directory contains a 
> "doc" directory. The contents of this directory seems to miss something.
> As i guess the class reference should go to: "doc\Programmer\Generated"
>
> Inside this "Generated" directory should be a subdirectory for each 
> module of OpendTect. I found an old documentation form here, that 
> contains a directory structure as described:
>
> ftp://opendtect.org/pub/devel/doc/Programmer/Generated/
>
> However in my local "Generated" directory only exsits a "html" 
> directory that seems to contain all documentation files. It seems to 
> have the same broken directory structure as the online resource.
>
> After that i tried to build a documentation using cmake. When 
> configuring with cmake i made sure "Build documentation" is checked. 
> Therefore cmake generated a "Doxyfile" inside the 
> "doc\Programmer\Generated" directory.
>
> When running this file with doxygen again the main pages for each 
> module are missing. It seems that doxygen has a problem with multiple 
> "main pages" because there is only one. But each module should have 
> its own, as in the second link.
>
> Can anyone point me in the direction to build a complete and 
> up-to-date doxygen documentation for OpendTect. I would like to have 
> something similar to the second link above.
>
> Maybe this is already up-to-date? In the meanwhile i study the 
> comments in the source files, but it would be so much more comfortable 
> to have a complete doxygen documentation.
>
> cheers
>
>
>
>
> _____________________________________________________________
> OpendTect Developers mailing list Developers at opendtect.org
> http://www.opendtect.org/mailman/listinfo/developers
>
> You receive this mail because you are listed on developers at opendtect.org To unsubscribe please go to http://lists.opendtect.org/mailman/options/developers . If you encounter any problems, please contact support at opendtect.org .


-- 
- Raman K Singh
- OpendTect Developer
-
- dGB Earth Sciences
- 304, Gateway Plaza, Hiranandani Gardens, Powai, Mumbai 400 076, India
- Phone: +91 22 25704984 , Fax: +91 22 25704977, Mobile: +91 9833452542
- mailto:raman.singh at opendtect.org, http://www.opendtect.org

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.opendtect.org/pipermail/developers/attachments/20121026/fdd41f8d/attachment.html>