| Revision: | 1.1 |
| Committed: | Tue Aug 11 23:09:27 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: TClassDocOutput.h 23908 2008-05-19 15:25:29Z 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 | #ifndef ROOT_TClassDocOutput | ||
| 13 | #define ROOT_TClassDocOutput | ||
| 14 | |||
| 15 | #ifndef ROOT_TDocOutput | ||
| 16 | #include "MitAna/Utils/interface/TDocOutput.h" | ||
| 17 | #endif | ||
| 18 | |||
| 19 | class TDocParser; | ||
| 20 | |||
| 21 | class TClassDocOutput: public TDocOutput { | ||
| 22 | protected: | ||
| 23 | enum ETraverse { | ||
| 24 | kUp, kDown, kBoth // direction to traverse class tree in ClassHtmlTree() | ||
| 25 | }; | ||
| 26 | |||
| 27 | Int_t fHierarchyLines; // counter for no. lines in hierarchy | ||
| 28 | TClass* fCurrentClass; // class to generate output for | ||
| 29 | TList* fCurrentClassesTypedefs; // typedefs to the current class | ||
| 30 | TDocParser* fParser; // parser we use | ||
| 31 | |||
| 32 | void ClassHtmlTree(std::ostream &out, TClass *classPtr, ETraverse dir=kBoth, int depth=1); | ||
| 33 | void ClassTree(TVirtualPad *canvas, Bool_t force=kFALSE); | ||
| 34 | |||
| 35 | Bool_t CreateDotClassChartIncl(const char* filename); | ||
| 36 | Bool_t CreateDotClassChartInh(const char* filename); | ||
| 37 | Bool_t CreateDotClassChartInhMem(const char* filename); | ||
| 38 | Bool_t CreateDotClassChartLib(const char* filename); | ||
| 39 | |||
| 40 | Bool_t CreateHierarchyDot(); | ||
| 41 | void CreateSourceOutputStream(std::ostream& out, const char* extension, TString& filename); | ||
| 42 | void DescendHierarchy(std::ostream &out, TClass* basePtr, Int_t maxLines=0, Int_t depth=1); | ||
| 43 | |||
| 44 | virtual void ListFunctions(std::ostream& classFile); | ||
| 45 | virtual void ListDataMembers(std::ostream& classFile); | ||
| 46 | |||
| 47 | virtual void WriteClassDocHeader(std::ostream& classFile); | ||
| 48 | virtual void WriteMethod(std::ostream & out, TString& ret, | ||
| 49 | TString& name, TString& params, | ||
| 50 | const char* file, TString& anchor, | ||
| 51 | TString& comment, TString& codeOneLiner, | ||
| 52 | TMethod* guessedMethod); | ||
| 53 | virtual void WriteClassDescription(std::ostream& out, const TString& description); | ||
| 54 | |||
| 55 | public: | ||
| 56 | TClassDocOutput(THtml& html, TClass* cl, TList* typedefs); | ||
| 57 | virtual ~TClassDocOutput(); | ||
| 58 | |||
| 59 | void Class2Html(Bool_t force=kFALSE); | ||
| 60 | Bool_t ClassDotCharts(std::ostream & out); | ||
| 61 | void CreateClassHierarchy(std::ostream& out, const char* docFileName); | ||
| 62 | |||
| 63 | void MakeTree(Bool_t force = kFALSE); | ||
| 64 | |||
| 65 | friend class TDocParser; | ||
| 66 | |||
| 67 | ClassDef(TClassDocOutput, 0); // generates documentation web pages for a class | ||
| 68 | }; | ||
| 69 | |||
| 70 | #endif // ROOT_TClassDocOutput |