ROOT logo
// @(#)root/html:$Id$
// Author: Axel Naumann 2007-01-09

/*************************************************************************
 * Copyright (C) 1995-2007, Rene Brun and Fons Rademakers.               *
 * All rights reserved.                                                  *
 *                                                                       *
 * For the licensing terms see $ROOTSYS/LICENSE.                         *
 * For the list of contributors see $ROOTSYS/README/CREDITS.             *
 *************************************************************************/

#include "TDocInfo.h"

#include "TClass.h"
#include "TSystem.h"

//______________________________________________________________________________
//
// Caches class documentation information, like which module it belongs to,
// and whether THtml should generate documentation for the class.
//______________________________________________________________________________


ClassImp(TClassDocInfo);

const char* TClassDocInfo::GetName() const
{
   // Get the class name, or (UNKNOWN) is no TClass object was found.
   return fClass ? fClass->GetName() : "(UNKNOWN)";
}

ULong_t TClassDocInfo::Hash() const
{
   // Forward to TClass::Hash(), return -1 if no TClass object was found.
   return fClass ? fClass->Hash() : (ULong_t)-1;
}

Int_t TClassDocInfo::Compare(const TObject* obj) const
{
   // Compare two TClassDocInfo objects; used for sorting.
   return fClass ? fClass->Compare(obj) : obj < this;
}

//______________________________________________________________________________
//
// BEGIN_HTML
// <p>Represents modules of the documented product. Modules are sub-groups of
// sources of a product, which get separate index pages and user-provided
// documentation. For ROOT, a module is a sub-directory; it often corresponds 
// to a library. TModuleDocInfo, for example, is part of the HTML module,
// which is documented <a href="../HTML_index.html">here</a>. The list of
// all modules is shown e.g. in the <a href="ClassIndex.html">class index</a>.</p>
// <p>A module's documentation is searched by combining its source directory
// (see <a href="#TModuleDocInfo:SetInputDir">SetInputDir()</a>) and the
// module documentation search path defined by 
// <a href="../THtml.html#THtml:SetModuleDocPath">THtml::SetModuleDocPath()</a>;
// it defaults to "../doc", i.e. for a module's sources in "module/src" its
// documentation is searched in "module/doc".
// END_HTML
//______________________________________________________________________________


ClassImp(TModuleDocInfo);
 TDocInfo.cxx:1
 TDocInfo.cxx:2
 TDocInfo.cxx:3
 TDocInfo.cxx:4
 TDocInfo.cxx:5
 TDocInfo.cxx:6
 TDocInfo.cxx:7
 TDocInfo.cxx:8
 TDocInfo.cxx:9
 TDocInfo.cxx:10
 TDocInfo.cxx:11
 TDocInfo.cxx:12
 TDocInfo.cxx:13
 TDocInfo.cxx:14
 TDocInfo.cxx:15
 TDocInfo.cxx:16
 TDocInfo.cxx:17
 TDocInfo.cxx:18
 TDocInfo.cxx:19
 TDocInfo.cxx:20
 TDocInfo.cxx:21
 TDocInfo.cxx:22
 TDocInfo.cxx:23
 TDocInfo.cxx:24
 TDocInfo.cxx:25
 TDocInfo.cxx:26
 TDocInfo.cxx:27
 TDocInfo.cxx:28
 TDocInfo.cxx:29
 TDocInfo.cxx:30
 TDocInfo.cxx:31
 TDocInfo.cxx:32
 TDocInfo.cxx:33
 TDocInfo.cxx:34
 TDocInfo.cxx:35
 TDocInfo.cxx:36
 TDocInfo.cxx:37
 TDocInfo.cxx:38
 TDocInfo.cxx:39
 TDocInfo.cxx:40
 TDocInfo.cxx:41
 TDocInfo.cxx:42
 TDocInfo.cxx:43
 TDocInfo.cxx:44
 TDocInfo.cxx:45
 TDocInfo.cxx:46
 TDocInfo.cxx:47
 TDocInfo.cxx:48
 TDocInfo.cxx:49
 TDocInfo.cxx:50
 TDocInfo.cxx:51
 TDocInfo.cxx:52
 TDocInfo.cxx:53
 TDocInfo.cxx:54
 TDocInfo.cxx:55
 TDocInfo.cxx:56
 TDocInfo.cxx:57
 TDocInfo.cxx:58
 TDocInfo.cxx:59
 TDocInfo.cxx:60
 TDocInfo.cxx:61
 TDocInfo.cxx:62
 TDocInfo.cxx:63