| Revision: | 1.1 |
| Committed: | Tue Aug 11 23:09:28 2009 UTC (15 years, 8 months ago) by loizides |
| Content type: | text/plain |
| Branch: | MAIN |
| CVS Tags: | Mit_032, Mit_031, Mit_025c_branch2, Mit_025c_branch1, Mit_030, Mit_029c, Mit_029b, Mit_030_pre1, Mit_029a, Mit_029, Mit_029_pre1, Mit_028a, Mit_025c_branch0, Mit_028, Mit_027a, Mit_027, Mit_026, Mit_025e, Mit_025d, Mit_025c, Mit_025b, Mit_025a, Mit_025, Mit_025pre2, Mit_024b, Mit_025pre1, Mit_024a, Mit_024, Mit_023, Mit_022a, Mit_022, Mit_020d, TMit_020d, Mit_020c, Mit_021, Mit_021pre2, Mit_021pre1, Mit_020b, Mit_020a, Mit_020, Mit_020pre1, Mit_018, Mit_017, Mit_017pre3, Mit_017pre2, Mit_017pre1, Mit_016, Mit_015b, Mit_015a, Mit_015, Mit_014e, Mit_014d, Mit_014c, Mit_014b, Mit_014a, Mit_014, Mit_014pre3, Mit_014pre2, Mit_014pre1, Mit_013d, Mit_013c, Mit_013b, Mit_013a, Mit_013, Mit_013pre1, Mit_012i, Mit_012h, Mit_012g, Mit_012f, Mit_012e, Mit_012d, Mit_012c, Mit_012b, Mit_012a, Mit_012, Mit_011a, Mit_011, Mit_010a, HEAD |
| Branch point for: | Mit_025c_branch |
| Log Message: | Added THtml from ROOT |
| # | User | Rev | Content |
|---|---|---|---|
| 1 | loizides | 1.1 | // @(#)root/html:$Id: TDocInfo.cxx 23937 2008-05-20 16:44:59Z axel $ |
| 2 | // Author: Axel Naumann 2007-01-09 | ||
| 3 | |||
| 4 | /************************************************************************* | ||
| 5 | * Copyright (C) 1995-2007, Rene Brun and Fons Rademakers. * | ||
| 6 | * All rights reserved. * | ||
| 7 | * * | ||
| 8 | * For the licensing terms see $ROOTSYS/LICENSE. * | ||
| 9 | * For the list of contributors see $ROOTSYS/README/CREDITS. * | ||
| 10 | *************************************************************************/ | ||
| 11 | |||
| 12 | #include "MitAna/Utils/interface/TDocInfo.h" | ||
| 13 | |||
| 14 | #include "TClass.h" | ||
| 15 | #include "TSystem.h" | ||
| 16 | |||
| 17 | //______________________________________________________________________________ | ||
| 18 | // | ||
| 19 | // Caches class documentation information, like which module it belongs to, | ||
| 20 | // and whether THtml should generate documentation for the class. | ||
| 21 | //______________________________________________________________________________ | ||
| 22 | |||
| 23 | |||
| 24 | ClassImp(TClassDocInfo) | ||
| 25 | |||
| 26 | const char* TClassDocInfo::GetName() const | ||
| 27 | { | ||
| 28 | // Get the class name, or (UNKNOWN) is no TClass object was found. | ||
| 29 | return fClass ? fClass->GetName() : "(UNKNOWN)"; | ||
| 30 | } | ||
| 31 | |||
| 32 | ULong_t TClassDocInfo::Hash() const | ||
| 33 | { | ||
| 34 | // Forward to TClass::Hash(), return -1 if no TClass object was found. | ||
| 35 | return fClass ? fClass->Hash() : (ULong_t)-1; | ||
| 36 | } | ||
| 37 | |||
| 38 | Int_t TClassDocInfo::Compare(const TObject* obj) const | ||
| 39 | { | ||
| 40 | // Compare two TClassDocInfo objects; used for sorting. | ||
| 41 | return fClass ? fClass->Compare(obj) : obj < this; | ||
| 42 | } | ||
| 43 | |||
| 44 | //______________________________________________________________________________ | ||
| 45 | // | ||
| 46 | // BEGIN_HTML | ||
| 47 | // <p>Represents modules of the documented product. Modules are sub-groups of | ||
| 48 | // sources of a product, which get separate index pages and user-provided | ||
| 49 | // documentation. For ROOT, a module is a sub-directory; it often corresponds | ||
| 50 | // to a library. TModuleDocInfo, for example, is part of the HTML module, | ||
| 51 | // which is documented <a href="./HTML_index.html">here</a>. The list of | ||
| 52 | // all modules is shown e.g. in the <a href="ClassIndex.html">class index</a>.</p> | ||
| 53 | // <p>A module's documentation is searched by combining its source directory | ||
| 54 | // (see <a href="#TModuleDocInfo:SetInputDir">SetInputDir()</a>) and the | ||
| 55 | // module documentation search path defined by | ||
| 56 | // <a href="./THtml.html#THtml:SetModuleDocPath">THtml::SetModuleDocPath()</a>; | ||
| 57 | // it defaults to "../doc", i.e. for a module's sources in "module/src" its | ||
| 58 | // documentation is searched in "module/doc". | ||
| 59 | // END_HTML | ||
| 60 | //______________________________________________________________________________ | ||
| 61 | |||
| 62 | |||
| 63 | ClassImp(TModuleDocInfo) |