Loading...
Searching...
No Matches
How to navigate in the examples documentation

The examples documentation is composed from a "global" documentation including all examples with classes which has unique names (eg. A01DetectorConstruction etc.) and from "standalone" documentations for examples with classes which names are not not unique (DetectorConstruction etc.).

Global documentation

The lists of "Related Pages" and "Modules" in the global documentation include the README pages for all examples categories and examples with both unique class names and generic ones. The lists "Namespaces" , "Classes" and "Files" include only the examples with unique class names.

That's why the README pages for the examples with a standalone documentation generated in the global documentation do not contain links to their classes (one cannot click on a class name here to get the class documentation). See eg. Example TestEm1.

Standalone documentations

The links from "global" documentation to the examples "standalone" documentation are available in the list of "Modules". When selecting eg. "TestEm1" here, you will be directed to the main page of its standalone documentation. When selecting then "Example TestEm1" from the "Related Pages" list here (there is only one page in the list) you will get the example documentation with hyperlinks to the classes etc.

All the lists in the examples "standalone" documentation include only the concerned example and eventually the classes shared with another examples or the classes from common if they are used in the example.

This organization was necessary as Doxygen does not support the classes with the same names in one system.


Applications | User Support | Publications | Collaboration