URLs to Doxygen documentation
Note: The Doxygen documentation for nightlies is built with one day of delay with respect to the build of the executables. At present we cannot build nightlies and doxygen for that nightly at the same time.
Soft links and TWiki variables
When you write web pages, which point to the Doxygen documentation of specific packages, you should use the shortcuts, which simplify the URL paths. Their definitions and values are for HTML and TWiki, respectively:
-
Links to the release area :
http://cern.ch/atlas-computing/links/latestDocDirectory
http://cern.ch/atlas-computing/links/nightlyDocDirectory -
Variables defined in WebPreferences :
%LATESTDOCDIRECTORY%
%NIGHTLYDOCDIRECTORY%
<package_name>/html/, e.g.
http://cern.ch/atlas-computing/links/latestDocDirectory/AthenaExamples/html/In more detail the definitions are
| URL | AFS location |
|---|---|
| latestDocDirectory | /afs/cern.ch/atlas/software/builds/AtlasOffline/latest/InstallArea/doc/ |
| nightlyDocDirectory | /afs/cern.ch/atlas/software/builds/nightlies/dev/AtlasOffline/latest_doxygen/InstallArea/doc/ |
Note that the packages are listed "flat" in the doxy directory "doc"; the directory structure of the packages on CVS is not reflected in the doxy directory.
Please use these shortcuts for the paths. You should never use a URL, which contains
/SOFTWARE/OO/.
Such URLs using the old web
on /afs/cern.ch/atlas/www/GROUPS/SOFTWARE/OO/ are now obsolete.
Selecting a specific AtlasOffline release or Nightly release
If you want to point to documentation, which is different from the latest release or latest nightlies,
then construct the path by using the predefined shortcuts
buildDirectory and nightlyDevDirectory as shown below for releases and nightlies, respectively
For HTML pages
-
http://cern.ch/atlas-computing/links/buildDirectory/AtlasOffline/<release>/InstallArea/doc/<package>/html/
http://cern.ch/atlas-computing/links/nightlyDevDirectory/AtlasOffline/<rel_x>/InstallArea/doc/<package>/html/ - Examples :
http://cern.ch/atlas-computing/links/buildDirectory/AtlasOffline/12.2.0/InstallArea/doc/AnalysisExamples/html/
http://cern.ch/atlas-computing/links/nightlyDevDirectory/AtlasOffline/rel_0/InstallArea/doc/AnalysisExamples/html/
For TWiki pages
-
%BUILDDIRECTORY%/AtlasOffline/<release>/InstallArea/doc/<package>/html/
%NIGHTLYDEVDIRECTORY%/AtlasOffline/<rel_x>/InstallArea/doc/<package>/html/ - Examples :
%BUILDDIRECTORY%/AtlasOffline/12.2.0/InstallArea/doc/AnalysisExamples/html/
%NIGHTLYDEVDIRECTORY%/AtlasOffline/rel_0/InstallArea/doc/AnalysisExamples/html/
Warning
- Some releases have no Doxygen documentation built. An example is AtlasOffline release 12.0.6.
- The above description is valid for the so-called project releases after release 11.2.0.
See also
There are three different possibilities to access the doxygen documentation; use the application, which serves best your needs:
- Access to Doxygen-generated documentation
- Doxy list of classes -- allows a search for Packages and classes.
- Doxygen Global Search
- AMI access to doxy doc -- lets you select the ATLAS release and the project; provides also access to CVSView and LXR; displays a clickable tree of project dependencies.
- BNL Software browser -- allows selection per ATLAS release and package; provides also access to CVSView and LXR.