Doxygen Documentation

To find information about the different processors you can use the documentation which can be generated with doxygen. To limit the number of documented classes listed on the page, each subproject (digitisation, reconstruction, analysis etc.) has its own doc directory.

To generate the documentation, go to the doc directory where the Doxyfile resides. Now call doxygen, which generates a html subdirectory. With your preferred browser you can now open the index.html inside this directory.

To generate the documentation for the reconstruction processors for instance:

tpcuser:~/MarlinTPC_trunk> cd reconstruction/doc
tpcuser:~/MarlinTPC_trunk/reconstruction/doc> doxygen
tpcuser:~/MarlinTPC_trunk/reconstruction/doc> firefox file:///home/tpcuser/MarlinTPC_trunk/reconstruction/doc/html/index.html

Now use the classes tab to get a list of all the processors and helper classes in the reconstruction section.

-- MartinKillenberg - 22 Sep 2008

Edit | Attach | Watch | Print version | History: r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r1 - 2008-09-22 - MartinKillenberg
 
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    ILCTPC All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2020 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback